Skip to main content
The reduce_only response field documented on this page is coming soon. The documentation is published in advance for integration planning. The field is not yet returned by the API. See Reduce-only orders for details.
Query or subscribe to active (unexecuted) orders across specified markets. The server pushes ordersPending_update events in real time on every order state change. Subscribe to multiple markets simultaneously by passing market names in the params array.
Connect to wss://api.whitebit.com/ws — see WebSocket Overview for protocol details and keepalive requirements.

Rate limits

Query pending orders (one-time)

Fetch current pending orders for a market without subscribing to updates. Request Response

Subscribe to order updates

Update frequency

Updates are pushed in real time on every order state change (new, modified, partially filled).

Error codes

Order modification behavior

When POST /api/v4/order/modify is called, the matching engine cancels the original order and creates a replacement, producing two sequential events:
  1. event_id=3 (Finish) — original order cancelled. The id in the payload matches the old order_id.
  2. event_id=1 (New) — replacement order created with a new order_id.
Clients tracking orders by order_id must update the stored value after each modify call. Use client_order_id for stable correlation across modifications.
The private stream returns active orders, including orders using Retail Price Improvement (RPI) mode.

Order object

Fields present in both the query response (records[]) and the pushed ordersPending_update payload.