订阅增量订单簿
API说明
此Websocket API提供现货市场交易品种的实时增量订单簿,流式传输实时买卖盘数据。
注意:增量订单簿数据只能通过 Websocket API 获取。
注意事项
- 此接口提供带有序列号的增量订单簿。如果某个序列中市场没有变 化,响应将相应包含空的asks或bids。
- 只有方法2可用于实现此功能。
认证
这是一个公共Websocket,不需要认证。有关使用Websocket API的详细信息,请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法2
Websocket URL
频率限制
无
订阅参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| event | true | String | 订阅或取消订阅:sub: 订阅,unsub: 取消订阅。 注意:此参数区分大小写。 |
| params | true | Json | 请求的参数对象,包括: |
| -biz | true | String | 指定频道,例如,"exchange"。 注意:建议使用小写。 |
| -type | true | String | 定义功能类型,例如,"depth"。 注意:建议使用小写。 |
| -pairCode | true | String | 货币对ID,即78 : BTC_USDT。 注意:货币对ID与交易品种的映射关系可通过 获取所有交易品种24小时交易摘要 接口获取。 |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| biz | String | 频道名称,例如,"exchange"。 |
| pairCode | String | 货币对ID,即78 : BTC_USDT。 注意:货币对ID与交易品种的映射关系可通过 获取所有交易品种24小时交易摘要 接口获取。 |
| channel | String | 订阅类型,例如,"subscribe"。 |
| type | String | 消息类型,例如,"depth"。 |
| -result | Boolean | 订阅请求的结果:true/false。 |
| data | Json | 数据对象,包含以下字段: |
| -startSeq | Long | 深度更新的起始序列号。 |
| -endSeq | Long | 深度更新的结束序列号。 |
| -asks | Array | 卖单深度 |
| - | String | 报价货币计的价格 |
| - | String | 基础货币计的数量 |
| - | String | 序列号 |
| -bids | Array | 买单深度 |
| - | String | 报价货币计的价格 |
| - | String | 基础货币计的数量 |
| - | String | 序列号 |
订阅示例
以下Python代码展示了如何订阅BTC-USDT的增量订单簿。
注意:完整代码示例请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法2。
subscription_params = {"event":"sub",
"params":{
"biz":"exchange",
"type":"depth",
"pairCode":"78"}} # "78"表示BTC-USDT
SpotWebsocketPublic(url, subscription_params) # 函数SpotWebsocketPublic()在章节(简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法2)中定义
注意:完整Java代码示例请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法2。
响应示例
以下是上述Python订阅返回的示例响应。Websocket订阅将实时更新增量订单簿。为简洁起见,以下仅提供初始响应:
{"biz":"exchange","pairCode":"78","data":{"result":true},"channel":"subscribe","type":"depth"}
{"biz":"exchange","pairCode":"78","data":
"{\"startSeq\":4999544967,\"endSeq\":4999544973,
\"asks\":[
[\"94734.66\",\"0.1137\",\"4999544972\"],
[\"94733.65\",\"0.0685\",\"4999544971\"],
[\"94732.06\",\"0.0000\",\"4999544970\"]],
\"bids\":[
[\"94730.63\",\"0.0903\",\"4999544967\"],
[\"94728.84\",\"0.0554\",\"4999544973\"]]}","type":"depth"},......