订阅 KLine 数据

market.$contract_code.kline.$period

是否验签: 否

接口权限: 读取

限频: 行情类的公开接口，比如：获取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（次季合约标识）
period	string	true	K线周期	仅支持小写：1min, 5min, 15min, 30min, 1hour,4hour,1day, 1mon

数据更新

参数	数据类型	是否必填	描述	取值范围
ch	string	true	请求参数
ts	long	true	响应生成时间点，单位：毫秒
<tick>		false
id	long	true	K线ID,也就是K线时间戳，K线起始时间
mrid	long	true	订单ID
vol	decimal	true	成交量张数。 值是买卖双边之和
count	decimal	true	成交笔数。 值是买卖双边之和
open	decimal	true	开盘价
close	decimal	true	收盘价,当K线为最晚的一根时，是最新成交价
low	decimal	true	最低价
high	decimal	true	最高价
amount	decimal	true	成交量(币), 即 sum(每一笔成交量(张) * 单张合约面值/该笔成交价)。 值是买卖双边之和
trade_turnover	decimal	true	成交额, 即sum（每一笔成交张数 * 合约面值 * 成交价格）。 值是买卖双边之和
</tick>		false

订阅示例

{
  "sub": "market.BTC-USDT.kline.1min",
  "id": "id1"
}

订阅成功示例

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.BTC-USDT.kline.1min",
  "ts": 1489474081631
}

数据更新示例

{
  "ch": "market.BTC-USDT.kline.1min",
  "ts": 1603707124366,
  "tick": {
    "id": 1603707120,
    "mrid": 131592424,
    "open": 13067.7,
    "close": 13067.7,
    "high": 13067.7,
    "low": 13067.7,
    "amount": 0.004,
    "vol": 4,
    "trade_turnover": 52.2708,
    "count": 1
  }
}

取消订阅示例

{
  "unsub": "market.BTC-USDT.kline.1min",
  "id": "id1"
}