WebSocket API 订阅说明
topq-exchange edited this page Dec 19, 2019
·
2 revisions
WebSocket协议是基于TCP的一种新的网络协议。它实现了客户端与服务器之间在单个 tcp 连接上的全双工通信,由服务器主动发送信息给客户端,减少了频繁的身份验证等不必要的开销。其最大优点有两个:
- 两方请求的 header 数据很小,大概只有2 Bytes。
- 服务器不再是被动的接到客户端的请求后才返回数据,而是有了新数据后主动推送给客户端。 以上 WebSocket 协议带来的优点使得其十分适用于数字货币行情和交易这种实时性强的接口。
- 访问地址: wss://kline.topliq.com/websocket
- 支持订阅的数据: KLine, Market Depth, Trade, Ticker
- 推送机制为第一次全量数据,之后增量推送新数据。
{
"dataType":"281_ENTRUST_ADD_BTC_USDT",
"dataSize":50,
"action":"ADD"
}
- dataType: 订阅的数据类型,详见以下语法解释
- dataSize: 订阅的数据条数,决定首次全量数据的条数,不传或者为 0 则返回一条数据
- action: 订阅的动作类型,ADD:增加数据订阅,DEL:移除数据订阅
参数前面带有$,表示可变参数。 如$marketId
数据类型 | dataType | action | 描述 |
---|---|---|---|
kline | $marketId_KLINE_$klineType_$symbol | ADD/DEL | 依据周期,订阅交易对的K线数据 |
Market Depth | $marketId_ENTRUST_ADD_$symbol | ADD/DEL | 依据交易对,订阅交易对的深度数据 |
Trade Detail | $marketId_TRADE_$symbol | ADD/DEL | 依据交易对,订阅交易对的成交数据 |
Market Tickers | ALL_TRADE_STATISTIC_24H | ADD/DEL | 订阅全部交易对的24小时的Ticker数据 |
Market Tickers-single-market | $marketId_TRADE_STATISTIC_24H | ADD/DEL | 依据市场id,订阅单个交易对24小时的Ticker数据 |
- $marketId: 市场id,可从获取市场列表接口获取
- $klineType:K 线周期,可选值:1M, 5M, 15M, 30M, 1H, 1D
- $symbol:交易对, 为marketId相对应的交易对名字,如BTC_USDT
- 技术讨论群: telegram(加群时请注明uid和编程语言),我们将尽力帮您答疑解惑。
English Documents click here