/ws endpoint as private streams. After you connect, you send JSON messages to subscribe or unsubscribe to logical channels; the server pushes typed payloads defined in AsyncAPI and summarized on the WebSocket API page.
Connection
- Open WSS to the host for your environment — see Environments (for example
wss://beta.rocket-cluster-1.com/ws; confirm path and servers in AsyncAPI). - Subscribe with the JSON kinds in AsyncAPI.
What counts as “public”
Multiplexed streams typically include market-wide feeds such as:- Instrument metadata and listing-style updates
- Order book snapshots and deltas (when offered)
- Last trade, mark, index, or candle-style updates
- Funding or similar broadcast events
ClientMessage / ServerMessage).
Per-stream reference
Under Streams in this section you will find one page per public subscription (order book, price feeds, candles, funding, and so on). Each page uses the same AsyncAPI playground and message schemas as WebSocket API.Subscribing
- Send
Subscribewith the kind and parameters your feed requires; sendUnsubscribeto stop. - After a reconnect, subscribe again; subscriptions usually do not resume automatically.
- Avoid sending duplicate subscribes for the same logical feed so you do not receive duplicate events.
SubscribeConfirmation / UnsubscribeConfirmation when the operation is accepted.
Heartbeats
SendPing JSON frames; the server replies with Pong. Use this in addition to any WebSocket-level ping policy your infrastructure requires so idle connections are not dropped.
Ordering and recovery
Use sequence or timestamp fields when the schema provides them. On disconnect, reconnect, resubscribe, and apply your book merge rules if you consume depth updates.Errors
Structured failures useServerMessage::Error. Interpret codes and messages per your integration, then fix the subscription, backoff, or reconnect as needed — see Error responses.
For account-scoped streams (orders, positions, balances), read Private WebSocket streams.