WebSocket 介绍

Copy page

Binance Web3 API 提供基于 WebSocket 的实时数据推送。连接受 API Key 保护，请在接入前完成 API Key 的申请，并在发起连接时使用 WebSocket 鉴权 API 获取对应的 Token。

连接方式

订阅域名：wss://web3-stream.binance.com/w3w/stream

发起连接前，请先获取 WebSocket 鉴权 Token，并将 Token 添加到 URL 参数中。

示例：

Code
wss://web3-stream.binance.com/w3w/stream?token=xxx

订阅方式

连接成功后，即可发起订阅或取消订阅。

订阅参数

参数名	类型	是否必须	说明
id	int	必须	每次发起连接时随机生成，该连接生命周期内保持不变
method	String	必须	取值范围：SUBSCRIBE / UNSUBSCRIBE
params	List<String>	必须	要订阅的 stream，关于 stream 的定义，会在每个功能模块的 WebSocket 文档中单独给出

示例：

Code
{
  "id": 1,
  "method": "SUBSCRIBE",
  "params": [
    "w3w@onchainos@pub@price@CT_501@5UnvDYKxRxdDjPkMbFAWDJfcZaYgat3FzzzSsUUMpump"
  ]
}

响应参数

参数名	类型	是否必须	说明
stream	String	必须	与发起订阅的 stream 相同
data	Object	必须	响应数据

示例：

Code
{
  "stream": "w3w@onchainos@pub@price@CT_501@5UnvDYKxRxdDjPkMbFAWDJfcZaYgat3FzzzSsUUMpump",
  "data": {
    "p": "0.00001234",
    "t": 1700000000000
  }
}

注意事项

• 每个连接有效期不超过 24 小时，请妥善处理断线重连。
• 服务端每 3 分钟会发送 ping 帧，客户端应当在 10 分钟内回复 pong 帧，否则服务端会主动断开连接。允许客户端发送不成对的 pong 帧（即客户端可以以高于每 15 分钟一次的频率发送 pong 帧以保持连接）。
• WebSocket 服务器每秒最多接受 10 个订阅消息。
• 如果用户发送的消息超过限制，连接会被断开。反复被断开的 IP 有可能被服务器屏蔽。
• 单个连接最多可以订阅 1024 个 streams。