private/subscribe

Subscribe to one or more channels. The name of the channel determines what information will be provided, and in what form.

Note - This method has distinct API rate limiting requirements: Sustained rate: ~3.3 requests/second. For more information, see Rate Limits.

📖 Related Article: Market Data Collection Best Practices

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/subscribe \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 4235,
  "method": "private/subscribe",
  "params": {
    "channels": [
      "deribit_price_index.btc_usd"
    ]
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 4235,
  "result": [
    "deribit_price_index.btc_usd"
  ]
}

Query Parameters

channels · string[] · required

A list of channels to subscribe to.

Example:

["deribit_price_index.btc_usd"]

label · string

Optional label which will be added to notifications of private channels (max 16 characters).

Example:

"TestLabel1"

Response

200

application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · string[] · required

A list of subscribed channels.

id · integer

The id that was sent in the request