Subscription Management
Private
WebSocket Only

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

get/private/unsubscribe

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/unsubscribe
  • Auth
    none declared

Query parameters

channelsstring[] 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.

[
  "deribit_price_index.btc_usd"
]

Response

Successfully unsubscribed from channels

jsonrpcstring
idinteger
resultstring[]

List of channels that were successfully unsubscribed in this request

Example response

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

Changes

No recorded changes to this operation across all 11 revisions of this API.