Subscribing & Unsubscribing

Once connected to the WebSocket API you can subscribe to various feeds using the subscribe or unsubscribe commands.

These commands should be JSON with the following properties:

Property	Type	Description
type	string	Command you are sending to the WebSocket (subscribe or unsubscribe).
feeds	string[]	List of the feeds that should be subscribed/unsubscribed to/from, respectively.

Subscribing

To begin receiving feed messages, you must send a subscribe message to the server indicating which feeds to receive. This message is mandatory—you may be disconnected if no subscribe has been received.

To ensure optimal performance, create a separate WebSocket connection for each feed type you subscribe to. This segregation ensures that time-sensitive updates, such as balances or open-orders messages, are not impacted by high-frequency feeds like order books.

Subscribe Message

// Request -> Subscribe to feed(s)
{
    "type": "subscribe", 
    "feeds": ["<feed 1>", "<feed 2>", ...]
}

Once a subscribe message is received the server responds with a subscribe message that lists all feeds you are subscribed to. Subsequent subscribe messages add to the list of subscriptions.

// Response -> Subscribe request
{
    "type": "success",
    "sequence": 2,
    "timestamp": 1727392002151355776,
    "payload": {
        "action": "subscribe",
        "feeds": [
            "<feed 1>",
            "<feed 2>",
            ...
        ]
    },
    "action": "subscribe"
}

Example Code

NodeJS

const subscribeMsg = {
  type: 'subscribe',
  feeds: ['ticker.sfox.btcusd']
}
ws.send(JSON.stringify(subscribeMsg));

Python

subscribe_msg = {
    "type": "subscribe",
    "feeds": ["ticker.sfox.btcusd"],
}

await ws.send(json.dumps(subscribe_msg))

Unsubscribing

To unsubscribe from a feed or feeds, send an unsubscribe message. The structure is equivalent to subscribe messages.

Unsubscribe Message

// Request -> Unsubscribe to feed(s)
{
    "type": "unsubscribe", 
    "feeds": ["<feed 1>", "<feed 2>", ...]
}

Once a unsubscribe message is received the server responds with an unsubscribe message that lists all feeds you are unsubscribed from.

// Response -> Subscribe request
{
    "type": "success",
    "sequence": 4,
    "timestamp": 1727394717752870042,
    "payload": {
        "action": "unsubscribe",
        "feeds": [
            "<feed 1>",
            "<feed 2>",
            ...
        ]
    },
    "action": "unsubscribe"
}

Example Code

NodeJS

const unsubscribeMsg = {
  type: 'unsubscribe',
  feeds: ['ticker.sfox.btcusd']
}
ws.send(JSON.stringify(unsubscribeMsg))

Python

unsubscribe_msg = {
    "type": "unsubscribe",
    "feeds": ["ticker.sfox.btcusd"],
}

await ws.send(json.dumps(unsubscribe_msg))