private/unsubscribe

Unsubscribe from one or more channels. The response contains only the channels that were successfully unsubscribed in this request.

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

Note: The result field in the response contains only the channels that were successfully processed and unsubscribed from this specific request. It does not include all previously subscribed topics. If a channel in the request is invalid, not subscribed, or fails validation, it will not appear in the result.

Try in API console

cURL

cURL

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

200

jsonObject

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

Query Parameters

channels · string[] · required

A list of channels to unsubscribe from. Only successfully unsubscribed channels will be returned in the result. See Notifications and Subscriptions for all available channels.

Example:

["deribit_price_index.btc_usd"]

Response

200

application/json

Successfully unsubscribed from channels

jsonrpc · string

Example:

"2.0"

id · integer

Example:

8691

result · string[]

List of channels that were successfully unsubscribed in this request

Example:

["deribit_price_index.btc_usd"]