Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Subscription Management
Private
WebSocket Only

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

For a complete list of available subscription channels and their notification formats, see Notifications and Subscriptions.

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

get/private/subscribe

Query parameters

channelsstring[] required

A list of channels to subscribe to. See Notifications and Subscriptions for all available channels.

[
  "deribit_price_index.btc_usd"
]
labelstring
Example:TestLabel1

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

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

resultstring[] required

A list of subscribed channels.

Example response

{
  "result": [
    "deribit_price_index.btc_usd"
  ]
}