Ws subscribe params
All V1 Websocket Subscription Requests are housed in this wrapper. You may specify a stream and a list of feeds to subscribe to.
When subscribing to the same primary selector again, the previous secondary selector will be replaced. See Overview
page for more details.
Sequence numbers can be either gateway-specific or global:
- Gateway Unique Sequence Number: Increments by one per stream, resets to 0 on gateway restart.
- Global Unique Sequence Number: A cluster-wide unique number assigned to each cluster payload, does not reset on gateway restarts, and can be used to track and identify message order across streams using sequence_number
and prev_sequence_number
in the feed response.
Set useGlobalSequenceNumber = true
if you need a persistent, unique identifier across all streams or ordering across multiple feeds.
NameLite |
Type | RequiredDefault |
Description |
---|---|---|---|
streams |
string | True | The channel to subscribe to (eg: ticker.s / ticker.d) |
selectorss1 |
[string] | True | The list of feeds to subscribe to |