用户数据流请求

订阅用户数据流 (USER_STREAM)

{
  "id": "d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7",
  "method": "userDataStream.subscribe"
}

订阅当前 WebSocket 连接中的用户数据流。

注意：

• 此方法需要使用 Ed25519 密钥并经过鉴权的 WebSocket 连接。请参考 session.logon。
• 如果需要查看订阅状态,可以通过 session.status 查询，当userDataStream 字段值为 true 时,表示您有一个有效的订阅.
• 用户数据流在 JSON 和 SBE 会话 中均可用。
  • 有关事件格式详情，请参阅 用户数据流。
  • 对于 SBE，仅支持 SBE 模式 2:1 或更高版本。

权重: 2

参数: 无

响应:

{
  "id": "d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7",
  "status": 200,
  "result": {}
}

取消订阅用户数据流 (USER_STREAM)

{
  "id": "d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7",
  "method": "userDataStream.unsubscribe"
}

取消订阅当前 WebSocket 连接中的用户数据流。

权重: 2

参数: 无

响应:

{
  "id": "d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7",
  "status": 200,
  "result": {}
}

Listen Key 管理 (已弃用)

[!IMPORTANT] 这些请求已被弃用，这意味着我们以后会删除这些请求。 请通过订阅 WebSocket API 来获得用户账户更新。

以下请求管理 用户数据流 订阅。

开始用户数据流 (USER_STREAM) （已弃用）

{
  "id": "d3df8a61-98ea-4fe0-8f4e-0fcea5d418b0",
  "method": "userDataStream.start",
  "params": {
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A"
  }
}

开始新的用户数据流

注意： 数据流将在 60 分钟后关闭，除非定期发送 userDataStream.ping 请求。

权重: 2

参数:

名称	类型	是否必需	描述
apiKey	STRING	YES

数据源: 缓存

响应:

之后在 WebSocket Stream 上订阅收到的 listen key。

{
  "id": "d3df8a61-98ea-4fe0-8f4e-0fcea5d418b0",
  "status": 200,
  "result": {
    "listenKey": "xs0mRXdAKlIPDRFrlPcw0qI41Eh3ixNntmymGyhrhgqo7L6FuLaWArTD7RLP"
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000,
      "count": 2
    }
  ]
}

Ping 用户数据流 (USER_STREAM) （已弃用）

{
  "id": "815d5fce-0880-4287-a567-80badf004c74",
  "method": "userDataStream.ping",
  "params": {
    "listenKey": "xs0mRXdAKlIPDRFrlPcw0qI41Eh3ixNntmymGyhrhgqo7L6FuLaWArTD7RLP",
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A"
  }
}

即使在监听, 用户数据流也会在60分钟后会自动关闭。 若要保持用户数据流的活动状态，必须使用 userDataStream.ping 请求定期发送 ping，建议的是在每30分钟发送一次 ping。

权重: 2

参数:

名称	类型	是否必需	描述
listenKey	STRING	YES
apiKey	STRING	YES

数据源: 缓存

响应:

{
  "id": "815d5fce-0880-4287-a567-80badf004c74",
  "status": 200,
  "response": {},
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000,
      "count": 2
    }
  ]
}

关闭用户数据流 (USER_STREAM) （已弃用）

{
  "id": "819e1b1b-8c06-485b-a13e-131326c69599",
  "method": "userDataStream.stop",
  "params": {
    "listenKey": "xs0mRXdAKlIPDRFrlPcw0qI41Eh3ixNntmymGyhrhgqo7L6FuLaWArTD7RLP",
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A"
  }
}

强制停止和关闭用户数据流

权重: 2

参数:

名称	类型	是否必需	描述
listenKey	STRING	YES
apiKey	STRING	YES

数据源: 缓存

响应:

{
  "id": "819e1b1b-8c06-485b-a13e-131326c69599",
  "status": 200,
  "response": {},
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000,
      "count": 2
    }
  ]
}