跳到主要内容

订阅增量订单簿

API说明

此Websocket API提供现货市场交易品种的实时增量订单簿,流式传输实时买卖盘数据。

注意:增量订单簿数据只能通过 Websocket API 获取。

注意事项

  1. 此接口提供带有序列号的增量订单簿。如果某个序列中市场没有变化,响应将相应包含空的asks或bids。
  2. 只有方法2可用于实现此功能。

认证

这是一个公共Websocket,不需要认证。有关使用Websocket API的详细信息,请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法2

Websocket URL

wss://ws.futurescw.com

频率限制

订阅参数

参数必填类型描述
eventtrueString订阅或取消订阅:sub: 订阅,unsub: 取消订阅。
注意:此参数区分大小写。
paramstrueJson请求的参数对象,包括:
-biztrueString指定频道,例如,"exchange"。
注意:建议使用小写。
-typetrueString定义功能类型,例如,"depth"。
注意:建议使用小写。
-pairCodetrueString货币对ID,即78 : BTC_USDT。
注意:货币对ID与交易品种的映射关系可通过 获取所有交易品种24小时交易摘要 接口获取。

响应参数

参数类型描述
bizString频道名称,例如,"exchange"。
pairCodeString货币对ID,即78 : BTC_USDT。
注意:货币对ID与交易品种的映射关系可通过 获取所有交易品种24小时交易摘要 接口获取。
channelString订阅类型,例如,"subscribe"。
typeString消息类型,例如,"depth"。
-resultBoolean订阅请求的结果:true/false。
dataJson数据对象,包含以下字段:
-startSeqLong深度更新的起始序列号。
-endSeqLong深度更新的结束序列号。
-asksArray卖单深度
-String报价货币计的价格
-String基础货币计的数量
-String序列号
-bidsArray买单深度
-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"},......