Topics

Every Stream API topic available for subscribe / unsubscribe

The Stream API exposes 12 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/

TopicAccessDescription
futures/inverse/btc_usd/tickerPublicInverse futures aggregated ticker with last price, index, and funding
futures/inverse/btc_usd/lastPricePublicInverse futures last trade price updates
futures/inverse/btc_usd/indexPublicInverse futures index price updates
futures/inverse/btc_usd/bucketsPublicInverse futures volume ladder bucket updates
futures/inverse/btc_usd/fundingPublicInverse futures funding rate updates with the current settled rate and time
futures/inverse/btc_usd/isolated/tradesPrivateInverse futures isolated-margin trade lifecycle events (open, filled, closed, canceled, liquidation, stoploss, takeprofit, funding)
futures/inverse/btc_usd/cross/ordersPrivateInverse futures cross-margin order events (new, limit, canceled)
futures/inverse/btc_usd/cross/positionPrivateInverse futures cross-margin position state updates (new, limit, cancel, leverage, deposit, withdraw, liquidation, funding)
futures/inverse/btc_usd/ohlc/{timeframe}PublicOHLC candle updates

wallet/

TopicAccessDescription
wallet/depositPrivateWallet deposit events
wallet/withdrawalPrivateWallet withdrawal events

(top-level)

TopicAccessDescription
announcementsPublicPlatform announcements (add and remove)

OHLC topics share the same payload — the trailing segment selects the timeframe (1m, 5m, 1h, 1d, …). See OHLC for the full list of timeframes.

On this page