Public
Public Channels
Public channels — no authentication required.
Channels
| Channel | Example | Frequency | Guide |
|---|---|---|---|
l2:bbo:{instrument} | l2:bbo:BTC_USDC-PERPETUAL | On BBO change | bbo |
l2:perps:{freq}:{instrument} | l2:perps:100:BTC_USDC-PERPETUAL | 100ms, 250ms, 500ms. Cache recovery with since: {} | l2_orderbook |
l2:perps:grouped:{bucket}:{instrument} | l2:perps:grouped:0.5:ETH_USDC-PERPETUAL | 250ms. Cache recovery with since: {} | l2_grouped |
trades_perp:{instrument} | trades_perp:BTC_USDC-PERPETUAL | On trade. Last 100 on subscribe with recovery | trades_perp |
trades_option:{instrument} | trades_option:BTC_USDC-31OCT25-130000-C | On trade. Last 100 on subscribe with recovery | trades_option |
index_price:{token} | index_price:BTC | On change | — |
index_candles:{pair}:{resolution} | index_candles:BTC_USDC:60 | Live candle update | index_candles |
Parameters:
{instrument}— Instrument name. Perps:BTC_USDC-PERPETUAL,ETH_USDC-PERPETUAL. Options:BTC_USDC-31OCT25-130000-C{freq}— Update frequency in milliseconds:100,250,500{bucket}— Price bucket size for grouped book. ETH:0.1,0.2,0.5,1,10,100. BTC:1,2,5,10,100,1000{token}— Token symbol:BTC,ETH,ARB{pair}— Trading pair:BTC_USDC,ETH_USDC,ARB_USDC{resolution}— Candle period:1S,1(1m),5,15,30,60(1h),240,D,W,M
All prices and amounts are JSON strings to preserve decimal precision.
For the
index_pricechannel, the payload is a simple JSON object withvalue(number) andtimestamp(ms). No dedicated page — subscribe toindex_price:BTCand receive{ "value": 50000.5, "timestamp": 1704067200000 }.
Updated 1 day ago
