This document will no longer be maintained. Please use the new address https://docs.itick.org/

Crypto WebSocket Documentation

iTick.org Crypto WebSocket API provides streaming access to the latest data on major global cryptocurrencies. You can specify the channel to use by sending instructions in the form of operations. When events occur in the channels you subscribe to, our WebSockets will emit events to notify you.

Our WebSocket API is based on authorization, which controls which WebSocket clusters you can connect to and what types of data you can access. You can log in to view examples that include your API key and are personalized according to your authorization.

Step 1: Connect & Authenticate

With the Premium plan, you will be able to use a single connection to the cluster. If another connection tries to connect to the cluster at the same time, the current connection will be disconnected. If you need more connections to this cluster at the same time, you can contact support.

Connect to the cluster:

wscat -c wss://api.itick.org/crypto -H "token: a5ca43ba************1847ac9259ae290c8"

After connecting, you will receive the following two messages:
Connection established successfully

{
"code":1,
"msg": "Connected Successfully"
}

Authentication is successful, you will receive the following message

{
"code": 1,
"resAc": "auth",
"msg": "authenticated",
"data": {
"params": "a5ca43ba**************************************************1847ac9259ae290c8"
}
}

Verification failed, the connection will be disconnected and the process will be terminated

{
"code":0,
"resAc":"auth",
"msg": "auth failed"
}

Step 2: Subscription

After verifying your identity, you can request a stream. You can request multiple streams in the same request.

{
"ac":"subscribe",
"params":"BTCUSDT,ETHUSDT",
"types":"quote"
}

params: underlying code, supports multiple subscriptions
types: subscription type, depth market, quote

Subscription returns content successfully.

{
"code":1,
"resAc":"subscribe",
"msg": "subscribe Successfully"
}

Subscription returns content failed. As follows: the maximum number of package plans is exceeded, and the subscription parameters are wrong.

{
"code":0,
"resAc":"subscribe",
"msg": "exceeding the maximum subscription limit"
}

{
"code":0,
"resAc":"subscribe",
"msg": "cannot be resolved action"
}

Step 3: Response Content

iTick.org WebSocket clients must be able to handle many incoming messages per second. Due to the nature of the WebSocket protocol, if the client is slow to get messages from the server, iTick.org's server must buffer messages and send them as fast as the client can receive them. If the client consumes messages too slowly for a long time, iTick.org's server-side buffer may become too large. If this happens, iTick.org will terminate the WebSocket connection. If you encounter this situation frequently, please consider subscribing to fewer symbols or channels.

After the subscription is successful, the data is sent as follows.

Quote response content

{
"code": 1,
"data": {
"s": "ETH_USDT",
"ld": 3034,
"t": 1731690011321,
"v": 0.6186,
"tu": 1876.832564,
"ts": 0,
"type": "quote"
}
}

Quote response content

{
"code": 1,
"data": {
"s": "ETH_USDT",
"a": [
{
"po": 1,
"p": 3034.01,
"v": 10.6023,
"o": 10.6023
},
{
"po": 2,
"p": 3034.03, 
"v": 0.0017, 
"o": 0.0017 
}, 
{ 
"po": 3, 
"p": 3034.18, 
"v": 0.0017, 
"o": 0.0017 
}, 
{ 
"po": 4, 
"p": 3034.26, 
"v": 0.0018, 
"o": 0.0018 
}, 
{ 
"po": 5, 
"p": 3034.27, 
"v": 0.21, 
"o": 0.21 
} 
], 
"b": [ 
{ 
"po": 1, 
"p": 3034, 
"v": 20.9758, 
"o": 20.9758 
}, 
{ 
"po": 2, 
"p": 3033.99,
"v": 1.8408,
"o": 1.8408
},
{
"po": 3,
"p": 3033.98,
"v": 0.003,
"o": 0.003
},
{
"po": 4,
"p": 3033.97,
"v": 0.0065,
"o": 0.0065
},
{
"po": 5,
"p": 3033.94,
"v": 0.003,
"o": 0.003
}
],
"type": "depth"
}
}

K-line response content

{
"code": 0,
"msg": null,
"data": {
"s":"ETH_USDT",
"t":1,
"k":
{
"tu": 157513,
"c": 3059.39,
"t": 1731660060000,
"v": 28,
"h": 3061.41,
"l": 3055.24,
"o": 3055.36
}
}
}

t Kline cycle: Cycle 1 minute, 2 five minutes, 3 ten minutes, 4 thirty minutes, 5 one hour, 6 two hours, 7 four hours, 8 one day, 9 one week, 10 one month

Step 4: Keep heartbeat

The client sends to the server

{
"ac":"ping",
"params":"1731688569840"
}

The server sends to the client

{
"resAc":"pong",
"data": {"params":"1731688569840"}
}

The timestamps of ping and pong need to be consistent