Interface WebSocketRequestSubscriptionsList

Requests all current subscriptions active on the WebSocket session.

interface WebSocketRequestSubscriptionsList {
    method: "subscriptions";
    cid?: string;
    markets?: string[];
}

Properties

method: "subscriptions"

A subscriptions request will provide a response with a list of all current subscriptions for the client.

cid?: string

Requests may optionally provide a cid parameter to identify the request a response should be associated with.

When provided, the onResponse callback object will include the provided cid as a property.

markets?: string[]

A top-level markets array can be used to allow multiple subscriptions to inherit this array without having define them themselves.

When a subscription does not define the markets parameter, it will inherit the top-level markets array provided here.