配置信息

协议与接口概览：REST vs WebSocket

殴易开放平台主要提供两种数据传输协议,开发者需根据场景选择：

1. REST API（请求/响应模式）：
   • 适用场景：账户资产查询、历史订单查询、下单、撤单等非高频操作。
   • 特点：逻辑简单，易于调试，但实时性稍弱,有请求频率限制。
2. WebSocket API（长连接模式）：
   • 适用场景：实时行情订阅（K线、深度、最新成交）、账户余额变动推送。
   • 特点：双向通信，数据延迟极低,适合高频策略和实时监控。

技术对接核心：签名认证

这是 API 对接中最关键、也是最容易出错的环节，殴易使用 HMAC SHA256 算法对请求进行签名,以确保请求在传输过程中未被篡改。

签名逻辑解析：

所有私有接口（如交易、查资产）都需要在 HTTP Header 中携带以下鉴权信息：

• OK-ACCESS-KEY：你的 API Key
• OK-ACCESS-PASSPHRASE：你创建 API 时设置的口令
• OK-ACCESS-TIMESTAMP：当前 UTC 时间戳（格式：2023-10-27T10:00:00Z）
• OK-ACCESS-SIGN：签名结果

签名生成步骤：

1. 构造待签名字符串： Prehash = timestamp + method + requestPath + body

   • method：请求方法（GET/POST）,必须大写。
   • requestPath：请求接口路径（如 /api/v5/account/balance）。
   • body：如果是 GET 请求，通常为空字符串；如果是 POST 请求，需传入 JSON 字符串（注意不要有空格）。

2. 生成签名： 使用你的 Secret Key 作为密钥，对 Prehash 字符串进行 HMAC SHA256 加密，然后进行 Base64 编码。

Python 代码示例（签名函数）：

import base64
import hmac
import datetime
import json
def get_signature(timestamp, method, request_path, body, secret_key):
    # 1. 拼接字符串
    if isinstance(body, dict):
        body = json.dumps(body)
    message = timestamp + method.upper() + request_path + body
    # 2. HMAC SHA256 加密
    mac = hmac.new(bytes(secret_key, encoding='utf8'), bytes(message, encoding='utf-8'), digestmod='sha256')
    # 3. Base64 编码
    d = mac.digest()
    return base64.b64encode(d).decode()

实战演练：查询账户余额

假设我们要查询现货账户的余额（GET 请求）。

• 接口地址：GET /api/v5/account/balance
• 时间戳：2023-10-27T12:00:00Z

Python 完整请求示例：

import requests
import base64
import hmac
import datetime
api_key = "YOUR_API_KEY"
secret_key = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"
base_url = "https://www.okx.com"  # 殴易 API 基础地址
def get_headers(method, request_path, body=""):
    # 获取当前 ISO 格式时间
    timestamp = datetime.datetime.utcnow().isoformat(timespec='milliseconds') + 'Z'
    # 生成签名
    sign = get_signature(timestamp, method, request_path, body, secret_key)
    headers = {
        'OK-ACCESS-KEY': api_key,
        'OK-ACCESS-SIGN': sign,
        'OK-ACCESS-TIMESTAMP': timestamp,
        'OK-ACCESS-PASSPHRASE': passphrase,
        'Content-Type': 'application/json'
    }
    return headers
# 发起请求
method = "GET"
request_path = "/api/v5/account/balance"
url = base_url + request_path
headers = get_headers(method, request_path)
response = requests.get(url, headers=headers)
print(response.json())

常见问题与避坑指南

在对接过程中，您可能会遇到以下错误代码,请参考解决方案：

1. 错误代码 50113 / 50111 (Invalid Sign)：
   • 原因：签名错误。
   • 排查：检查时间戳格式是否为 ISO 8601；检查参数拼接顺序是否为 Time+Method+Path+Body；检查 Body 中是否有多余的空格或换行。
2. 错误代码 50011 (Rate Limit Reached)：
   • 原因：请求频率过高,触发了风控限制。
   • 解决：优化代码逻辑，使用 WebSocket 替代高频轮询的 REST 请求；在代码中加入指数退避的重试机制。
3. Connection Timeout：
   • 原因：网络问题。
   • 解决：如果您在中国大陆，可能需要配置科学的网络环境或使用阿里云/腾讯云的香港服务器进行部署。

殴易交易所开放平台的 API 对接虽然涉及加密签名等复杂逻辑，但只要严格遵循官方文档的规范，就能快速构建起自动化的交易系统，对于初学者，建议先使用官方提供的 Postman Collection 或 SDK（如 Python SDK okx-python-sdk-api）进行测试,理解交互流程后再自行封装底层代码。

掌握 API 对接，意味着您已经迈出了从“手动交易者”向“量化交易员”转变的关键一步，祝您的策略运行稳定,收益长虹！