Skip to main content
WSS
This stream is active on the optionsOrders subscription, which is on by default when you connect. It allows you to create, modify, cancel, and cancel all orders, and receive fill and liquidation notifications. Name the contract in market unless the connection is scoped to a single contract. A command’s responses reach only connections whose optionsOrders subscription covers its contract: a command for a contract outside the connection’s filter is still executed, but its responses do not arrive on that connection.

​
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 — cancelOrder skips this step and goes straight to confirmation or error
  2. A confirmation (statusCode: 200) once the action has taken effect, or an error if it failed
cancelAllOrders is acknowledged once, with the number of cancels it dispatched, and produces one cancelOrder confirmation or error per order — each carrying the sweep’s clientRequestId. The acknowledgment and the per-order results arrive in any order. It is also available over HTTP as Cancel All Orders, so you can release capital from whichever connection is still up; see Releasing Capital on Disconnect.

​
Notifications

completeFillOrder and partialFillOrder are pushed as your orders execute. liquidation is pushed when your account is liquidated, once for each contract the liquidation acts on, before its orders are cancelled and positions closed. See Margin & Liquidation.

​
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. At most 10 contracts are backfilled per reconnect; any others are listed in expiredMarkets, so reconcile those over HTTP. 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.

expiration
type:string
required

Contract expiration, e.g. 24JUN26. Requires market; omit to match every expiration.

strike
type:string
required

Strike price, e.g. 62000. Requires expiration; omit to match every strike.

type
type:string
required

C (call) or P (put). Requires strike; omit to match both.

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
Cancel All Orders
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
Modify Order — Error
type:object
Cancel Order — Confirmation
type:object
Cancel Order — Error
type:object
Cancel All Orders — Acknowledgment
type:object
Cancel All Orders — Error
type:object
Order Filled — Complete Fill
type:object
Order Filled — Partial Fill
type:object
Session Backfill
type:object
Liquidation
type:object

Pushed when your account is liquidated, once for each contract the liquidation cancels orders on or closes a position in, before those orders are cancelled and positions closed. Carries no clientRequestId.