OKEx

Channels

• /ops
  Logical channel representing operation frames sent from the client over any of the three sockets. OKX multiplexes subscribe, unsubscribe, login, ping, order, batch-orders, amend-order, cancel-order, m
  OKX V5 WebSocket API
• account
  Account balance updates per currency. Requires login.
  OKX V5 WebSocket API
• account-greeks
  Portfolio Greeks per currency. Requires login.
  OKX V5 WebSocket API
• adl-warning
  Auto-deleveraging warning per instrument.
  OKX V5 WebSocket API
• algo-advance
  Advanced algo (iceberg/TWAP) order updates. Requires login.
  OKX V5 WebSocket API
• balance-and-position
  Combined balance and position deltas (1-stream consistency). Requires login.
  OKX V5 WebSocket API
• bbo-tbt
  Tick-by-tick best bid / best offer (top of book), 10ms.
  OKX V5 WebSocket API
• block-tickers
  Block trading ticker.
  OKX V5 WebSocket API
• books
  400-level order book; initial snapshot then incremental updates (100ms).
  OKX V5 WebSocket API
• books-l2-tbt
  400-level L2 tick-by-tick order book (10ms). VIP5+ required.
  OKX V5 WebSocket API
• books5
  Top-5 order book snapshot pushed every 100ms when changed.
  OKX V5 WebSocket API
• books50-l2-tbt
  50-level L2 tick-by-tick order book (10ms). VIP4+ required.
  OKX V5 WebSocket API
• call-auction-details
  Call auction state for instruments in auction phase.
  OKX V5 WebSocket API
• candlesticks
  OHLCV candles. Subscribe with channel name from candle1Y, candle6M, candle3M, candle1M, candle1W, candle1D, candle2D, candle3D, candle5D, candle12H, candle6H, candle4H, candle2H, candle1H, candle30m,
  OKX V5 WebSocket API
• copytrading-notification
  Copy-trading notifications for lead traders and followers. Requires login.
  OKX V5 WebSocket API
• deposit-info
  Deposit notifications per currency. Requires login.
  OKX V5 WebSocket API
• economic-calendar
  Economic calendar events. Login may be required for full data.
  OKX V5 WebSocket API
• estimated-price
  Estimated delivery / exercise / settlement price for FUTURES and OPTION.
  OKX V5 WebSocket API
• event-contract-markets
  Event contract market data updates.
  OKX V5 WebSocket API
• fills
  Trade fill stream (VIP5+). Requires login.
  OKX V5 WebSocket API
• funding-rate
  Funding rate for SWAP perpetuals. Pushed when rate changes or on schedule.
  OKX V5 WebSocket API
• grid-orders-contract
  Contract grid bot order updates. Requires login.
  OKX V5 WebSocket API
• grid-orders-spot
  Spot grid bot order updates. Requires login.
  OKX V5 WebSocket API
• grid-positions
  Grid position details and PnL. Requires login.
  OKX V5 WebSocket API
• grid-sub-orders
  Individual grid sub-order events. Requires login.
  OKX V5 WebSocket API
• index-candlesticks
  Index candlesticks. Channel names: index-candle1Y/6M/3M/1M/1W/1D/2D/3D/5D/ 12H/6H/4H/2H/1H/30m/15m/5m/3m/1m and -utc variants.
  OKX V5 WebSocket API
• index-tickers
  Index ticker for an underlying index (e.g. BTC-USD index).
  OKX V5 WebSocket API
• instruments
  Push when instrument state changes (new listing, expiry, suspension).
  OKX V5 WebSocket API
• liquidation-orders
  Recent liquidation orders for SWAP, FUTURES, OPTION, MARGIN.
  OKX V5 WebSocket API
• liquidation-warning
  Imminent forced liquidation warning. Requires login.
  OKX V5 WebSocket API
• mark-price
  Mark price for MARGIN, FUTURES, SWAP, OPTION; pushed every 200ms when changed.
  OKX V5 WebSocket API
• mark-price-candlesticks
  Mark price candlesticks. Channel names: mark-price-candle1Y/6M/3M/1M/1W/1D/2D/3D/5D/ 12H/6H/4H/2H/1H/30m/15m/5m/3m/1m and their UTC variants (-utc suffix).
  OKX V5 WebSocket API
• open-interest
  Push open interest for SWAP, FUTURES, OPTION instruments every 3s.
  OKX V5 WebSocket API
• option-summary
  Aggregated option summary (Greeks, IV) per option underlying.
  OKX V5 WebSocket API
• option-trades
  Public option trades. Subscribe with instType=OPTION and instFamily.
  OKX V5 WebSocket API
• orders
  Order create / update / fill / cancel notifications. Requires login.
  OKX V5 WebSocket API
• orders-algo
  Algo order updates (TP/SL, trigger, trailing stop, iceberg, TWAP). Requires login.
  OKX V5 WebSocket API
• position-risk-warning
  Liquidation / margin-call risk warnings. Requires login.
  OKX V5 WebSocket API
• positions
  Position updates per instrument and side. Requires login.
  OKX V5 WebSocket API
• price-limit
  Maximum buy / minimum sell limit prices, pushed every 5s.
  OKX V5 WebSocket API
• public-block-trades
  Public block trades per instrument.
  OKX V5 WebSocket API
• public-struc-block-trades
  Public structured block trades.
  OKX V5 WebSocket API
• quotes
  Quote events for RFQs. Requires login.
  OKX V5 WebSocket API
• recurring-buy
  Recurring buy plan order updates. Requires login.
  OKX V5 WebSocket API
• rfqs
  Request-for-quote events for the subscribed account. Requires login.
  OKX V5 WebSocket API
• sprd-books
  Spread order book.
  OKX V5 WebSocket API
• sprd-orders
  Spread trading order updates. Requires login.
  OKX V5 WebSocket API
• sprd-public-tickers
  Public spread ticker.
  OKX V5 WebSocket API
• sprd-public-trades
  Public spread trades.
  OKX V5 WebSocket API
• sprd-tickers
  Spread ticker (account scope). Requires login for private fields.
  OKX V5 WebSocket API
• sprd-trades
  Spread trading fill stream. Requires login.
  OKX V5 WebSocket API
• struc-block-trades
  Account-scoped structured block trade confirmations. Requires login.
  OKX V5 WebSocket API
• tickers
  24h ticker per instrument; pushed every 100ms when changed.
  OKX V5 WebSocket API
• trades
  Public trades feed (aggregated, pushed up to 100ms after match).
  OKX V5 WebSocket API
• trades-all
  All-trades feed (every trade, non-aggregated).
  OKX V5 WebSocket API
• withdrawal-info
  Withdrawal status updates. Requires login.
  OKX V5 WebSocket API