跳到主要内容

订阅订单簿

API说明​

此Websocket API提供指定交易品种实时订单簿深度数据，包括买单和卖单。

注意：合约订单簿数据可通过RESTful和Websocket接口获取。本页是Websocket接口的描述。如需了解RESTful接口，请参见 跳转

注意事项​

  1. 此Websocket返回指定交易品种的深度信息。
  2. 此Websocket不允许用户指定买单/卖单数量。默认情况下，它在响应中返回100个买单和卖单。

认证​

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

Websocket URL​

wss://ws.futurescw.com/perpum

频率限制​

此订阅的频率限制为每IP每2秒10个请求。

订阅参数​

参数必填类型描述
eventtrueString订阅或取消订阅。sub：订阅；unsub：取消订阅。注意：此参数区分大小写。
paramstrueJson请求参数对象，包括：
-biztrueString指定频道，例如"futures"。注意：建议使用小写。
-typetrueString定义功能类型，例如"depth"。注意：建议使用小写。
-pairCodetrueString交易品种基础货币（例如，BTC或btc）。此参数不区分大小写。注意：对于以数字开头的合约（例如1000PEPE），大写和小写格式都有效。

响应参数​

参数类型描述
bizString指定频道，例如"futures"
typeString功能类型，例如"depth"
resultboolean表示订阅或取消订阅是否成功：true，false
channelString指定执行的操作：subscribe或unsubscribe
pairCodeString交易品种基础货币，即BTC
dataJson数据对象，包含以下字段：
-askList卖方深度，包含100个
-bidsList买方深度，包含100个
--pBigDecimal价格
--mBigDecimal数量
nString交易品种基础货币，即btc

订阅示例​

以下Python代码展示了如何订阅BTC的订单簿。

注意：完整代码示例请参考简介 > 认证和代码示例 > 合约 > Websocket公共接口。

subscription_params =  { "event": "sub",
                        "params": {
                        "biz": "futures",
                        "pairCode": "BTC",
                        "type": "depth"}}
url = "wss://ws.futurescw.com/perpum"
FuturesWebsocketPublic(url, subscription_params)   # function FuturesWebsocketPublic() is defined in section (Introduction > Authentication & Code Snippet > Futures > Websocket Public Interface.)

注意：完整Java代码示例请参考简介 > 认证和代码示例 > 合约 > Websocket公共接口。

响应示例​

Websocket将实时更新BTC的订单簿。为简洁起见，以下仅显示Python订阅的8个级别的卖单和买单：

{'biz': 'futures',
 'pairCode': 'BTC',
 'data': {'result': True},
 'channel': 'subscribe',
 'type': 'depth'}
{'biz': 'futures',
 'pairCode': 'BTC',
 'data': {'asks': [{'p': '95640.3', 'm': '0.807'},
   {'p': '95640.5', 'm': '0.201'},
   {'p': '95640.6', 'm': '0.317'},
   {'p': '95640.7', 'm': '0.08'},
   {'p': '95640.8', 'm': '0.234'},
   {'p': '95640.9', 'm': '0.39'},
   {'p': '95641', 'm': '0.454'},
   ..........................................
   {'p': '96202.8', 'm': '5.819'}],
  'bids': [{'p': '95640.2', 'm': '0.068'},
   {'p': '95639.9', 'm': '1.381'},
   {'p': '95639.8', 'm': '0.099'},
   {'p': '95639.7', 'm': '0.655'},
   {'p': '95639.5', 'm': '0.441'},
   {'p': '95639.4', 'm': '0.187'},
   {'p': '95639.2', 'm': '1.104'},
   ..........................................
   {'p': '95095.8', 'm': '0.02'}]......},
  'n': 'btc'},
 'type': 'depth'}