Topics
Every Stream API topic available for subscribe / unsubscribe
The Stream API exposes 19 subscription topics. Pass any of them in the topics array of subscribe and unsubscribe calls. Public topics are open to anyone connected to the WebSocket; private topics require an authenticated session and a permission scope.
futures/inverse/btc_usd/
| Topic | Access | Description |
|---|---|---|
futures/inverse/btc_usd/ticker | Public | Inverse futures aggregated ticker with last price, mark price (index field), and funding |
futures/inverse/btc_usd/lastPrice | Public | Inverse futures last price updates: weighted average of the reference exchanges' perpetual last trade prices (display only) |
futures/inverse/btc_usd/index | Public | Inverse futures mark price updates (index field) |
futures/inverse/btc_usd/buckets | Public | Inverse futures volume ladder bucket updates: executable bid and ask prices by order size; market orders fill at them and order levels trigger on them |
futures/inverse/btc_usd/funding | Public | Inverse futures funding rate updates with the current settled rate and time |
futures/inverse/btc_usd/isolated/trades | Private | Inverse futures isolated-margin trade lifecycle events (open, filled, closed, canceled, liquidation, stoploss, takeprofit, funding) |
futures/inverse/btc_usd/cross/orders | Private | Inverse futures cross-margin order events (new, limit, canceled) |
futures/inverse/btc_usd/cross/position | Private | Inverse futures cross-margin position state updates (new, limit, cancel, leverage, deposit, withdraw, liquidation, funding) |
futures/inverse/btc_usd/ohlc/{timeframe} | Public | OHLC candle updates |
wallet/
| Topic | Access | Description |
|---|---|---|
wallet/deposit | Private | Wallet deposit events |
wallet/withdrawal | Private | Wallet withdrawal events |
(top-level)
| Topic | Access | Description |
|---|---|---|
announcements | Public | Platform announcements (add and remove) |
inverse_perp/btc_usd/ticker | Public | Aggregated ticker with last price, mark, and funding |
inverse_perp/btc_usd/lastPrice | Public | Last price updates: weighted average of the reference exchanges' perpetual last trade prices (display only) |
inverse_perp/btc_usd/mark | Public | Mark price updates |
inverse_perp/btc_usd/buckets | Public | Volume ladder bucket updates: executable bid and ask prices by order size; market orders fill at them and order levels trigger on them |
inverse_perp/btc_usd/ohlc/{timeframe} | Public | OHLC candle updates |
inverse_perp/btc_usd/funding | Public | Funding rate updates with the current settled rate and time |
inverse_perp/btc_usd/isolated/trades | Private | Isolated-margin trade lifecycle events (open, filled, closed, canceled, liquidation, stoploss, takeprofit, funding) |
OHLC topics share the same payload — the trailing segment selects the timeframe (
1m,5m,1h,1d, …). See OHLC for the full list of timeframes.