Cryptocurrency Real-time Quotes WEBSOCKET API Provides streaming access to the latest data of major global cryptocurrencies, pushing tick transactions, K-line updates, order book depth, and aggregated quotes for mainstream cryptocurrencies such as Bitcoin and Ethereum in real-time. Supports multi-exchange quote aggregation with millisecond-level low-latency delivery.
Crypto WebSocket Documentation
The iTick Crypto WebSocket API provides streaming access to the latest global crypto data. You can specify the channels to use by sending instructions in the form of operations. When events occur in your subscribed channels, our WebSockets emit events to notify you.
Our WebSocket API is authorization-based, where authorization controls which WebSocket clusters you can connect to and what types of data you can access. You can log in to view examples containing your API key and personalized according to your authorization.
Step 1: Connect
With the advanced plan, you will be able to use a single connection to the cluster. If another connection attempts to connect to the cluster simultaneously, the current connection will be disconnected. If you need more connections to this cluster simultaneously, you can contact support.
Connect to the cluster:
wscat -c wss://api.itick.org/crypto -H "token: 2abf6c0*************************dd8a1930a2f48ba14a"
After connecting, you will receive the following message:
{
"code":1,
"msg": "Connected Successfully"
}
Step 2: Authentication
After successful authentication, you will receive the following message:
{
"code":1,
"resAc":"auth",
"msg": "authenticated"
}
If authentication fails, the connection will be disconnected and the process terminated:
{
"code":0,
"resAc":"auth",
"msg": "auth failed"
}
Step 3: Subscribe
After authentication, you can request streams. You can request multiple streams in the same request.
{
"ac":"subscribe",
"params":"BTCUSDT,ETHUSDT",
"types":"quote"
}
params：Symbol Code, supports multiple subscriptions.
types: Subscription types, depth (order book), quote (quotes), tick (transactions)
Subscription successful response.
{
"code":1,
"resAc":"subscribe",
"msg": "subscribe Successfully"
}
Subscription failure response. Below are respectively: exceeding the maximum subscription limit of the package plan, subscription parameter error.
{
"code":0,
"resAc":"subscribe",
"msg": "exceeding the maximum subscription limit"
}
{
"code":0,
"resAc":"subscribe",
"msg": "cannot be resolved action"
}
Step 4: 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 retrieves messages from the server slowly, iTick.org's servers must buffer messages and send them at a rate the client can receive. If the client consumes messages too slowly for an extended period, iTick.org's server-side buffer may become too large. If this happens, iTick.org will terminate the WebSocket connection. If you frequently encounter this situation, consider subscribing to fewer symbols or channels.
After successful subscription, data is sent as follows:
Trade Response Content
{
"code": 1,
"data": {
"s": "ETH_USDT",
"ld": 225.215,
"v": 16742235,
"t": 1731689407000,
"type": "tick"
}
}
Quote Response Content
{
"code": 1,
"data": {
"s": "ETH_USDT",
"ld": 3034,
"t": 1731690011321,
"v": 0.6186,
"tu": 1876.832564,
"ts": 0,
"type": "quote"
}
}
Market Depth 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"
}
}
Kline 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 period: Period 1 minute, 2 five minutes, 3 fifteen minutes, 4 thirty minutes, 5 one hour, 8 one day, 9 one week, 10 one month
Step 5: Keep Alive
Client sends to server:
{
"ac":"ping",
"params":"1731688569840"
}
Server sends to client:
{
"resAc":"pong",
"data": {"params":"1731688569840"}
}
The timestamp of ping and pong must be consistent
