🤍

Websocket Subscribe & Unsubscribe

Order data of any trading pair (level2)
​
Subscribe
Unsubscribe
{
  "type": "subscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "level2"
  ],
  "token": "" #option
}
{
  "type": "unsubscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "level2"
  ],
  "token": "" #option
}
Notice:
When you subscribe to level2 for the first time, you will receive the snapshot data by push-snapshot​
K-line data of a trading pair (1/3/5/15/30/60min/2/4/6/12/24hour)
​
Subscribe
Unsubscribe
Channel name comparison table
{
  "type": "subscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "candles_1m"
  ],
  "token": ""   # optional (JWT-token)
}
{
  "type": "unsubscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "candles_1m"
  ],
  "token": ""    # optional (JWT-token)
}
channel name
time
candles_1m
1min
candles_3m
3min
candles_5m
5min
candles_15m
15min
candles_30m
30min
candles_60m
60min
candles_120m
2hour
candles_240m
4hour
candles_360m
6hour
candles_720m
12hour
candles_1440m
24hour
Ticker info of a trading pair
Subscribe
Unsubscribe
{
  "type": "subscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "ticker"
  ],
  "token": ""    # optional (JWT-token)
}
{
  "type": "unsubscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "ticker"
  ],
  "token": ""    # optional (JWT-token)
}
Matching information of a trading pair
Subscribe
Unsubscribe
{
  "type": "subscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "match"
  ],
  "token": ""    # optional (JWT-token)
}
{
  "type": "unsubscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "match"
  ],
  "token": ""    # optional (JWT-token)
}
Success order information of a trading pair
Subscribe
Unsubscribe
{
  "type": "subscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "trade"
  ],
  "token": ""    # required (JWT-token) 
}
{
  "type": "unsubscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "trade"
  ],
  "token": ""    # required (JWT-token)
}
Order change infomation of a trading pair
Subscribe
Unsubscribe
{
  "type": "subscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "order"
  ],
  "token":""  # required (JWT-token)
}
{
  "type": "unsubscribe",                                
  "product_ids": [
    "UNI-USDC"
  ],
  "channels": [
    "order"
  ],
  "token": ""  # required (JWT-token)
}
The asset change information of an account
Subscribe
Unsubscribe
{
  "type": "subscribe",                                
  "currency_ids": [
    "UNI",
    "USDC"
  ],
  "channels": [
    "funds"
  ],
  "token": ""   # required (JWT-token)
}
{
  "type": "unsubscribe",                                
  "currency_ids": [
    "UNI",
    "USDC"
  ],
  "channels": [
    "funds"
  ],
  "token":""   # required (JWT-token)
}

channel name	time
candles_1m	1min
candles_3m	3min
candles_5m	5min
candles_15m	15min
candles_30m	30min
candles_60m	60min
candles_120m	2hour
candles_240m	4hour
candles_360m	6hour
candles_720m	12hour
candles_1440m	24hour

ZKEX2.0 MARKET MAKER APIS - Previous

Getting Started

Next - ZKEX2.0 MARKET MAKER APIS

Websocket Data Push

Last modified 14d ago