private/subscribe

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

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"
    ]
  }
}
'

import requests

url = "https://test.deribit.com/api/v2/private/subscribe"

payload = {
    "jsonrpc": "2.0",
    "id": 4235,
    "method": "private/subscribe",
    "params": { "channels": ["deribit_price_index.btc_usd"] }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 4235,
    method: 'private/subscribe',
    params: {channels: ['deribit_price_index.btc_usd']}
  })
};

fetch('https://test.deribit.com/api/v2/private/subscribe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.deribit.com/api/v2/private/subscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 4235,
    'method' => 'private/subscribe',
    'params' => [
        'channels' => [
                'deribit_price_index.btc_usd'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.deribit.com/api/v2/private/subscribe"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 4235,\n  \"method\": \"private/subscribe\",\n  \"params\": {\n    \"channels\": [\n      \"deribit_price_index.btc_usd\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/private/subscribe")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 4235,\n  \"method\": \"private/subscribe\",\n  \"params\": {\n    \"channels\": [\n      \"deribit_price_index.btc_usd\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/subscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 4235,\n  \"method\": \"private/subscribe\",\n  \"params\": {\n    \"channels\": [\n      \"deribit_price_index.btc_usd\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "jsonrpc": "2.0",
  "message": "<string>",
  "error": 123,
  "id": 123
}

Query Parameters

channels · string[] · required

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

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