Skip to main content
WSS
This stream is active on the orders subscription, which is on by default when you connect. It allows you to create, modify, and cancel orders, and receive fill 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 — 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

Notifications

completeFillOrder and partialFillOrder are pushed as your orders execute.
market
type:string
required

Option contract name (e.g. BTC-19JUN26-62000-C), or ALL to connect across all contracts.

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
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
Order Filled — Complete Fill
type:object
Order Filled — Partial Fill
type:object