订阅Market Depth增量数据

market.$contract_code.depth.size_${size}.high_freq

是否验签: 否

接口权限: 读取

限频: 行情类的公开接口，比如：获取K线数据、获取聚合行情、市场行情、获取行情深度数据、获取溢价指数K线、获取实时预测资金费率k线，获取基差数据、获取市场最近成交记录： websocket：req请求，同一时刻最多请求50次；sub请求，无限制，服务器主动推送数据

接口描述: 该接口支持全仓模式和逐仓模式 请求参数contract_code支持交割合约代码，格式为BTC-USDT-210625；同时支持合约标识，格式为 BTC-USDT（永续）、BTC-USDT-CW（当周）、BTC-USDT-NW（次周）、BTC-USDT-CQ（当季）、BTC-USDT-NQ（次季）。

订阅地址

环境	地址
线上环境	wss://api.sunx.io/ws/v1/market
线上环境（aws客户首选）	wss://api.sunx.io/ws/v1/market

请求参数

字段名称	类型	说明
无数据

规则说明

订阅(sub)	取消订阅(unsub)	规则
无数据

订阅参数

参数	数据类型	是否必填	描述	取值范围	默认值
contract_code	string	true	合约代码 或 合约标识	永续:BTC-USDT（永续合约代码） ，交割：BTC-USDT-210625（交割合约代码） 或 BTC-USDT-CW（当周合约标识）、BTC-USDT-NW（次周合约标识）、BTC-USDT-CQ（当季合约标识）、BTC-USDT-NQ（次季合约标识）
size	string	true	档位数	20:表示20档不合并的深度，150:表示150档不合并的深度

数据更新

参数	数据类型	是否必填	描述	取值范围
ch	string	true	数据所属的 channel，格式： market.$contract_code.depth.size_${size}.high_freq
ts	long	true	进入行情服务器系统时间点，单位：毫秒
<tick>		false
mrid	long	true	订单ID
id	long	true	tick ID
asks	object	true	卖盘,[price(挂单价), vol(此价格挂单张数)], 按price升序
bids	object	true	买盘,[price(挂单价), vol(此价格挂单张数)], 按price降序
ts	long	true	系统检测orderbook时间点，单位：毫秒
version	long	true	版本号
ch	string	true	数据所属的 channel，格式： market.$symbol.depth.size_${size}.high_freq
event	string	true	事件类型；"update":更新，表示推送买卖各20档或150档不合并深度的增量数据；"snapshot":快照值，表示推送买卖各20档或150档不合并深度的全量数据
</tick>		false

备注: 1、当"data_type"为incremental时，首次推送的"event"为"snapshot"的数据，且当重新发送订阅请求时，首次返回都是"snapshot"的数据； 2、深度即可以按照合约周期订阅，也可以按照合约代码订阅，行情系统在进行数据计算时，需要更新对应类型的数据； 3、version（版本号），是自增的序号，每次增加1，不管是增量还是全量数据,每个连接是唯一的。多个websocket连接的version是可能不同的。 4、每30ms检查一次orderbook，如果有更新，则推送，如果没有更新，则不推送。 5、如果是增量数据，要自己维护好本地的orderbook bidsasks 数据。

订阅示例

{
  "sub": "market.BTC-USDT.depth.size_20.high_freq",
  "data_type": "incremental",
  "id": "id generated by client"
}

订阅成功示例

{
  "status": "ok",
  "subbed": "market.BTC-USDT.depth.size_20.high_freq",
  "data_type": "incremental",
  "id": "id generated by client",
  "ts": 1489474081631
}

数据更新示例

{
  "ch": "market.BTC-USDT.depth.size_20.high_freq",
  "tick": {
    "asks": [
      [
        13081.9,
        206
      ],
      [
        13099.7,
        371
      ]
    ],
    "bids": [
      [
        13071.9,
        38
      ],
      [
        13060,
        400
      ]
    ],
    "ch": "market.BTC-USDT.depth.size_20.high_freq",
    "event": "snapshot",
    "id": 131597620,
    "mrid": 131597620,
    "ts": 1603707712356,
    "version": 1512467
  },
  "ts": 1603707712357
}

取消订阅示例

{
  "unsub": "market.BTC-USDT.depth.size_20.high_freq",
  "data_type": "incremental",
  "id": "id generated by client"
}