Skip to content

Public 请求与订阅说明

CoinTiger-API edited this page Jan 22, 2019 · 4 revisions

请求与订阅说明

1. 访问地址

wss://api.cointiger.com/exchange-market/ws

2. 数据压缩

WebSocket API 返回的所有数据都进行了 GZIP 压缩,需要 client 在收到数据之后解压。

3. 心跳

1.默认情况cointiger会维护心跳信息,在连续三次没有收到pong消息,会主动断开连接。

2.如果客户端维护心跳,则需要在15秒之内发送ping消息到服务端。否则服务端会断开连接。

WebSocket Server 发送心跳:

{"ping": 1519789122605}

WebSocket Client 应该返回:

{"pong": 1519789122605}

4. 订阅数据(sub)

订阅数据的格式

成功建立和 WebSocket API 的连接之后,向 Server 发送如下格式的数据来订阅数据:

{
 "event":"sub",
 "params":{
 	    "channel":"xxx",// xxx为对应的要订阅的频道名称
 	    "cb_id":"自定义"
          }
}

5. 取消订阅(unsub)

取消订阅的格式

WebSocket Client 订阅数据之后,可以取消订阅,取消订阅之后 WebSocket Server 将不会再发送该 topic 的数据,取消订阅的格式如下:

{
 "event":"unsub",
 "params":{
 	    "channel":"xxx",// xxx为对应的要订阅的频道名称
 	    "cb_id":"自定义"
 	  }
}