Skip to main content
WSS
This stream is available on the orders subscription. It allows you to create, modify, and cancel orders, update isolated position margin, and receive order notifications.

Multi-Step Responses

Order actions typically produce more than one message on this stream:
  1. An acknowledgment (statusCode: 202) confirming the request was received and is being processed
  2. A confirmation (statusCode: 200) once the action has taken effect, or an error (400/403/404/408/409/429/500) if it failed
modifyOrder treats the modification as a replacement: after the acknowledgment, the confirmation carries the replacement order, which has a new orderId; the original order is cancelled. See Order Modification for the full sequence.
updateMargin is a special case: if the requested margin already matches the current margin, the operation is a no-op and the 200 confirmation is returned directly without a prior 202 acknowledgment.

Notifications

completeFillOrder and partialFillOrder are pushed as your orders execute; rejectOrder is pushed when an order is rejected (for example, a post-only order that would have matched immediately).

Backfill

Connecting with a sessionId query parameter starts a WebSocket session on this stream: on connect, any messages missed since the last delivered position are backfilled first, followed by a sessionBackfill message summarizing the session. See WebSocket Session for the full field reference, session continuity semantics, and backfill limits.
market
type:string
required

A specific market (e.g. BTC-USDT) or ALL. When ALL is used, market must be supplied explicitly in the content of every request that accepts it.

sessionId
type:string
required

UUID identifying a session. Enables WebSocket Session on this stream. Omit to opt out.

Sec-WebSocket-Protocol
type:httpApiKey

Supply as authorization#<JWT> during the WebSocket handshake.

Create Order
type:object
Modify Order
type:object
Cancel Order By ID
type:object
Update Margin
type:object
Create Order — Acknowledgment
type:object
Create Order — Confirmation
type:object
Create Order — Error
type:object
Modify Order — Acknowledgment
type:object
Modify Order — Confirmation
type:object

The original order is cancelled and its replacement, under a new orderId, is on the book. The order is the replacement.

Modify Order — Error
type:object
Cancel Order — Acknowledgment
type:object
Cancel Order — Confirmation
type:object
Cancel Order — Error
type:object
Update Margin — Acknowledgment
type:object
Update Margin — Confirmation
type:object
Update Margin — Error
type:object
Order Filled — Complete Fill
type:object
Order Filled — Partial Fill
type:object
Order Rejected
type:object
Session Backfill
type:object