WebSocket 行情接口文档

最近更新：2025-01-10

---

1. 基本信息

• API Base URL : https://10.1.9.121:8080。
• 用于订阅账户数据的 listenKey 从创建时刻起有效期为60分钟。
• 可以通过 PUT 一个 listenKey 延长60分钟有效期。
• 可以通过DELETE一个 listenKey 立即关闭当前数据流，并使该listenKey 无效。
• 在具有有效listenKey的帐户上执行POST将返回当前有效的listenKey并将其有效期延长60分钟。
• WebSocket Base URL: ws://10.1.9.121/8088。
• 订阅账户数据流的stream名称为 /stream?listenKey=<listenKey>
• 账户数据流的消息不保证严格时间序; 请使用事件时间字段进行排序。
• 连接有效期: 每个连接有效期不超过 24 小时，请妥善处理断线重连。
• 时间戳单位: 所有时间和时间戳字段均以毫秒为单位。

---

2. 与Websocket账户接口相关的REST接口

2.1 生成 Listen Key (USER_STREAM)

POST /api/v1/userDataStream

开始一个新的数据流。除非发送 keepalive，否则数据流于60分钟后关闭。如果该帐户具有有效的listenKey，则将返回该listenKey并将其有效期延长60分钟。

2.1.1 请求参数

{}

2.1.2 响应参数

{
  "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

2.2 延长 Listen Key 有效期 (USER_STREAM)

PUT /api/v1/userDataStream

有效期延长至本次调用后60分钟。

2.2.1 请求参数

{
  "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

2.2.2 响应参数

{}

2.3 关闭 Listen Key (USER_STREAM)

DELETE /api/v1/userDataStream

关闭某账户数据流

2.3.1 请求参数

{
  "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

2.3.2 响应参数

{}

---

3. Websocket推送事件

3.1 订单更新

当用户的订单状态发生变化时，系统会推送订单更新事件，提供与该订单相关的最新状态信息。事件包含的内容可用于跟踪订单的生命周期和状态变化。

更新速度: 实时

Payload:

{
  "e": 1,                 // 事件类型: 订单更新
  "eT": 1499405658658,    // 事件时间 (毫秒时间戳)
  "t": 2,                 // 触发事件类型 (见枚举定义)
  "o": "Order12434324234", // 订单ID
  "s": "btc_usd",          // 交易对
  "p": "6000.1",           // 成交价格
  "v": "0.2",              // 成交量
  "oS": "BUY"              // 买卖方向 (BUY/SELL)
}

---

4.枚举定义

4.1 事件类型

• 1 - 订单更新

4.2 订单事件中订单类型

• 1 - 挂单成功
• 2 - 成交
• 3 - 撤单成功
• 5 - 自成交
• 6 - 完全成交