Exchange OS Open API 全局约定#

欢迎使用 Exchange OS Open API。

本 API 聚合 perp 与 spot，为外部开发者提供统一的 REST、WebSocket 和交易签名接口。业务线不通过 URL 路径区分，而是通过请求参数或 assetId 路由：

• 写接口通过 marketType 指定市场类型。
• 账户和交易读接口通常通过 assetId 推导市场类型。
• 市场产品查询接口可通过 marketType 进行筛选。

基础路径#

/api/v5/exchangeos/

完整 URL：

https://{host}/api/v5/exchangeos/{endpoint}

示例：

POST /api/v5/exchangeos/trade/place-order
GET /api/v5/exchangeos/market/instruments

环境信息#

标识约定#

计量单位#

perp 和 spot 的订单数量均以 Base Token 计量，不使用合约张数概念。

响应格式#

所有 REST 接口使用以下响应外壳：

{
  "code": "0",
  "msg": "",
  "data": []
}

写接口鉴权#

所有写接口必须携带以下请求头：

写操作签名模型#

所有写操作，包括下单、撤单、改单、调整杠杆、调整保证金、切换持仓模式和账户划转，都使用 EIP-712 Action 签名。

请求体结构：

{
  "action": {},
  "nonce": 1704067200000,
  "user": "0x...",
  "vaultAddress": "0x...",
  "signature": {
    "Ecdsa": {
      "r": "0x...",
      "s": "0x...",
      "v": 1
    }
  },
  "expiresAfter": 1704067260000
}

签名流程：

1. 组装完整的 canonical action。
2. 使用当前毫秒时间戳生成 nonce。
3. 使用已授权 Agent 的 ECDSA 私钥对 action 进行 EIP-712 签名。
4. 将签名后的请求提交至对应接口，并附带 OK-ACCESS-* 请求头。

服务端不会代替客户端组装或修改 action。签名完成后，任何字段修改都会导致签名校验失败。

子账户查询#

以下读接口支持可选参数 vaultAddress：

• 省略 vaultAddress：查询主账户数据。
• 传入 vaultAddress：查询指定子账户数据。

网关会验证该地址是否属于当前认证用户。

适用接口：

/account/balance
/account/positions
/account/max-size
/account/leverage-info
/account/position-tiers
/account/bills
/trade/order
/trade/orders-pending
/trade/orders-history
/trade/fills

以下接口固定使用主账户维度，不支持 vaultAddress：

/account/detail
/account/trade-fee

Rate Limit 总览#

Trade 接口

限流维度：按用户。

Account 接口

限流维度：按用户。

Market 接口

限流维度：按 IP。