Websocket Market Streams

Copy page

Live Subscribing/Unsubscribing to streams

• The following data can be sent through the websocket instance in order to subscribe/unsubscribe from streams. Examples can be seen below.
• The id used in the JSON payloads is an unsigned INT used as an identifier to uniquely identify the messages going back and forth.

Subscribe to a stream

Request

Code
{
  "method": "SUBSCRIBE",
  "params": ["btcusd_200925@aggTrade", "btcusd_200925@depth"],
  "id": 1
}

Response

Code
{
  "result": null,
  "id": 1
}

Unsubscribe to a stream

Request

Code
{
  "method": "UNSUBSCRIBE",
  "params": ["btcusd_200925@depth"],
  "id": 312
}

Response

Code
{
  "result": null,
  "id": 312
}

Listing Subscriptions

Request

Code
{
  "method": "LIST_SUBSCRIPTIONS",
  "id": 3
}

Response

Code
{
  "result": ["btcusd_200925@aggTrade"],
  "id": 3
}

Setting Properties

Currently, the only property can be set is to set whether combined stream payloads are enabled are not. The combined property is set to false when connecting using /ws/ ("raw streams") and true when connecting using /stream/.

Request

Code
{
  "method": "SET_PROPERTY",
  "params": ["combined", true],
  "id": 5
}

Response

Code
{
  "result": null,
  "id": 5
}

Retrieving Properties

Request

Code
{
  "method": "GET_PROPERTY",
  "params": ["combined"],
  "id": 2
}

Response

Code
{
  "result": true, // Indicates that combined is set to true.
  "id": 2
}