Skip to main content

Private WebSocket

The Private WebSocket endpoint provides real-time updates for user-specific data including orders, positions, account balances, and RFQs.
Authentication RequiredThis WebSocket endpoint requires API key authentication in the connection handshake. See the Authentication guide for details.

Endpoint

Subscription Types

Order Subscriptions

Subscribe to Orders

Leave marketSlugs empty to subscribe to all markets.

Order Snapshot Response

Initial snapshot of open orders:

Order Update Response

Real-time order execution updates:
Order quantities can contain decimals for partial-contract markets. lastShares is a string and may also contain a decimal quantity.

Position Subscriptions

Subscribe to Positions

Position Update Response

Position messages can include netPositionDecimal, qtyBoughtDecimal, qtySoldDecimal, bodPositionDecimal, and qtyAvailableDecimal, matching GET /v1/portfolio/positions. Use those fields when present; the older integer fields are rounded and remain for backward compatibility.

Account Balance Subscriptions

Subscribe to Balances

Balance Snapshot Response

Balance Update Response

RFQ Subscriptions

Beta access required. RFQ subscriptions are available only to Retail API users enabled for the Combo and RFQ beta. The same access gate applies to the REST RFQ API.
Subscribe without marketSlugs; the stream is private to the participant associated with the authenticated API key.
No separate success acknowledgment is sent. Events use the rfqEvent envelope, and each message contains exactly one event variant:
The stream is live and best effort: it has no replay or durable cursor. Unsubscribing, disconnecting, or an upstream failure ends the corresponding stream. Reconnect and reconcile with GET /v1/rfqs and GET /v1/rfqs/quotes; do not treat WebSocket delivery as the source of truth.

Execution Types

Ledger Entry Types

Order States

Order Intent

Subscription LimitsYou can subscribe to a maximum of 100 markets per subscription. Use multiple subscriptions if you need more.