Common Requests

Messages

{
  "message": "subscribe",
  "content": {
    "clientRequestId": "cfff0f58-8780-4cf2-b3d3-6439fed37304",
    "subscriptions": [
      "optionsPositions",
      "optionsOpenOrders",
      "publicOrderBook"
    ]
  }
}

{
  "resultType": "subscribed",
  "data": {
    "activeSubscriptions": [
      "orders",
      "optionsPositions",
      "optionsOpenOrders",
      "publicOrderBook"
    ],
    "requestedSubscriptions": [
      "optionsPositions",
      "optionsOpenOrders",
      "publicOrderBook"
    ],
    "clientRequestId": "cfff0f58-8780-4cf2-b3d3-6439fed37304",
    "statusCode": 200
  }
}

{
  "resultType": "unsubscribed",
  "data": {
    "activeSubscriptions": [
      "orders",
      "optionsPositions",
      "optionsOpenOrders"
    ],
    "requestedUnsubscriptions": [
      "publicOrderBook"
    ],
    "clientRequestId": "b21f0f58-8780-4cf2-b3d3-6439fed37304",
    "statusCode": 200
  }
}

WSS

?product=options&market=

{market}

Prefer the application-level ping message over WebSocket control frames when validating connectivity. Because it is handled as a normal data message, it confirms end-to-end reachability across the same path used by your subscriptions and requests. Control frames are processed separately by WebSocket infrastructure and can still succeed when application data is not flowing reliably.

Allowed Subscription Values

Subscription Value	Description
`orders`	Order creation and cancellation requests and notifications (active by default on connect)
`optionsContracts`	Contract definitions with mark price, IV, and Greeks (scoped by underlying + expiration)
`optionsQuotes`	Top-of-book bid/ask with IV (scoped by underlying + expiration)
`publicOrderBook`	Order book snapshots and deltas for a contract
`publicTrades`	Public trade executions for a contract
`optionsPositions`	Your open positions
`optionsOpenOrders`	Your open orders
`optionsRecentOrders`	Your recent order history
`optionsSettlements`	Your settlement results at expiry

The account summary stream is managed for you — issue an emitOptionsAccountSummary request and updates are delivered automatically; it is not a subscribe value.

Streams must be added with subscribe after connecting — they cannot be requested in the connection URL (except orders, which is active by default)
Only new (or currently active) subscriptions are added (or removed) — re-subscribing to an already active subscription, or unsubscribing from an inactive one, is a no-op
Other subscriptions remain unaffected
Changes apply immediately
Safe to call repeatedly (idempotent)
Does not affect other connections
Does not require reconnecting

Messages

{
  "message": "subscribe",
  "content": {
    "clientRequestId": "cfff0f58-8780-4cf2-b3d3-6439fed37304",
    "subscriptions": [
      "optionsPositions",
      "optionsOpenOrders",
      "publicOrderBook"
    ]
  }
}

{
  "resultType": "subscribed",
  "data": {
    "activeSubscriptions": [
      "orders",
      "optionsPositions",
      "optionsOpenOrders",
      "publicOrderBook"
    ],
    "requestedSubscriptions": [
      "optionsPositions",
      "optionsOpenOrders",
      "publicOrderBook"
    ],
    "clientRequestId": "cfff0f58-8780-4cf2-b3d3-6439fed37304",
    "statusCode": 200
  }
}

{
  "resultType": "unsubscribed",
  "data": {
    "activeSubscriptions": [
      "orders",
      "optionsPositions",
      "optionsOpenOrders"
    ],
    "requestedUnsubscriptions": [
      "publicOrderBook"
    ],
    "clientRequestId": "b21f0f58-8780-4cf2-b3d3-6439fed37304",
    "statusCode": 200
  }
}

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.

Ping

type:object

Add one or more streams to the current connection.

Unsubscribe

type:object

Remove one or more streams from the current connection.

Pong

type:object

Subscribed

type:object

Unsubscribed

type:object

Overview Order Creation Stream

⌘I

Guides

Formulas

WS Reference

API Reference

Allowed Subscription Values

​Allowed Subscription Values

​Subscribe / Unsubscribe Behavior

Allowed Subscription Values

Subscribe / Unsubscribe Behavior