URL
Query params
Example value:
BTC-USD. To get all supported markets, call /api/v1/markets endpoint.Comma-separated list of subscription types. Available subscription types:
orderCreation, tradeStream, orderBookStream. Defaults to orderCreation if omitted.Headers
See Authorization section on how to retrieve authorization token. Once token is received, setSec-WebSocket-Protocol headers in the WebSocket handshake request or on connect().
Example value (authorization token):
Request Envelope
All WebSocket requests follow the same top-level structure:messagedefines the request typecontentcontains request-specific parameters (can be omitted if no parameters)- An optional
clientRequestIdfield is supported for correlation
The following three requests do not support
clientRequestId yet, but will soon: ping, emitCompletedOrders, and emitOrderBook.Response Envelope
All WebSocket responses and stream messages follow a consistent top-level structure:datacontains the response or message payloadresultTypeidentifies the type of response or message (e.g., “subscribed”, “orderBookDelta”)
Dynamic Subscriptions
You can modify subscriptions dynamically after connecting using explicitsubscribe and unsubscribe requests.
Available Streams
There are three main streams you can subscribe to. Check out their respective documentation for details on the data they provide and any available requests.Order Creation Stream
Order creation acknowledgements and validation feedback
Trade Stream
Real-time trade updates and recent completed orders
Order Book Stream
Real-time order book updates and snapshots
Common Requests
Theping request is available regardless of your current subscriptions and can be used to monitor connection health.
Ping
Connection health monitoring - available even without any subscription
Deterministic Delivery
Multiple WebSocket connections with identical market and subscription parameters receive the same sequence of events with no per-connection filtering or divergence. This enables:- Multiple parallel connections for redundancy
- Hot standby consumers for failover
- Independent processes handling the same events
- Focused connections for specific stream subsets