Skip to navigation
Resources

Changelog

This changelog is illustrative and provided for demonstration purposes. Entries are representative of the OKX v5 API surface but should not be treated as the canonical release history. Always confirm against the official OKX API documentation before relying on a specific behavior in production.

Entries are listed with the most recent first. Each entry notes the affected product area, the nature of the change, and any migration guidance where a field or endpoint has been deprecated.

Spread trading and block trading

  • Added GET /api/v5/sprd/order-algo-history to retrieve completed algo spread orders (TWAP) alongside the existing GET /api/v5/sprd/order-algo active-order query.
  • Added the pxUsd and pxVol fields to block trade RFQ quote responses on GET /api/v5/rfq/quotes, enabling options quotes to be expressed in USD price or implied volatility.
  • New WebSocket channel sprd-orders-algo streams real-time state transitions for spread algo orders on the private channel.

Trading account

  • Added GET /api/v5/account/instruments returning the tradable instruments available to the authenticated account, filtered by the account’s current trading mode and permissions.
  • The account configuration response from GET /api/v5/account/config now includes spotBorrowAutoRepay and liquidationGracePeriod fields.
  • Position risk on GET /api/v5/account/positions now returns bePx (break-even price) for derivatives positions.

WebSocket

  • Added the account-greeks private channel, pushing option account-level greeks (delta, gamma, theta, vega) as positions and marks update.

Market data

  • Added GET /api/v5/market/history-mark-price-candles for historical mark price candlesticks, complementing the existing index and trade-price candle endpoints.
  • The order book endpoint GET /api/v5/market/books now accepts a sz value up to 400 for spot and margin instruments (previously 400 was restricted to specific instrument types).
  • New WebSocket channel mark-price-candle{bar} delivers mark price candles in real time, matching the request-cadence of index-candle{bar}.

Order book trading

  • Added POST /api/v5/trade/mass-cancel to cancel all open orders for a given instrument family in a single request, primarily for options market makers.
  • The attachAlgoOrds parameter on POST /api/v5/trade/order now supports attaching multiple take-profit / stop-loss brackets to a single order.
  • Added the linkedAlgoOrd field to GET /api/v5/trade/order responses, surfacing the algo order id linked to a placed order.

Funding

  • Added GET /api/v5/asset/withdrawal-history pagination via before / after cursors on the wdId field, replacing offset-based paging.
  • Added POST /api/v5/asset/monthly-statement to request a downloadable monthly transaction statement, with retrieval through GET /api/v5/asset/monthly-statement.
  • The deposit address response GET /api/v5/asset/deposit-address now returns the verifiedName field for networks that support beneficiary verification.

Grid trading

  • Added POST /api/v5/tradingBot/grid/adjust-investment to add margin or investment to a running spot or contract grid without stopping it.
  • The grid order details endpoint GET /api/v5/tradingBot/grid/orders-algo-details now includes annualizedRate and gridProfit breakdown fields.
  • New WebSocket channel grid-orders-spot pushes lifecycle events for spot grid bots on the private channel.

Trading account and WebSocket

  • Added GET /api/v5/account/position-tiers to fetch position and leverage tier information per instrument family.
  • The private positions WebSocket channel now emits pTime (push timestamp) distinct from uTime (data update timestamp) so consumers can measure delivery latency.

Deprecation. The legacy POST /api/v5/account/set-greeks endpoint is deprecated in favor of the greeksType parameter on POST /api/v5/account/set-account-level. The legacy endpoint will be removed in a future release; migrate to the account-level setting.

Market data

  • Added GET /api/v5/public/instrument-tick-bands returning per-price-band tick sizes for options instrument families.
  • The public instruments channel now includes the maxMktSz and maxLmtSz fields inline, removing the need for a separate lookup when validating order sizes.

Deprecation. The GET /api/v5/market/oracle endpoint is deprecated. Use GET /api/v5/market/index-components and GET /api/v5/market/index-tickers for index pricing data.