Unsubscribe

REQUEST
wss://ws.kraken.com
unsubscribe

Unsubscribe, can specify a channelID or multiple currency pairs.

Request

Request Schema

MESSAGE BODY

event string required

Value: unsubscribe

pair array of strings conditional

Condition: All channels which support pair subscriptions.

Example: ["BTC/USD", "MATIC/GBP"]

Unsubscribe to specific pairs.

reqid string

Optional client originated request identifier sent as acknowledgment in the response.

subscription object

name string required

Possible values: [book, ohlc, openOrders, ownTrades, spread, ticker, trade, *]

The name of the channel to unsubscribe. Wildcard "*" is supported.

depth integer conditional

Condition: 'book' channel only.

Unsubscribe to a specific depth.

interval integer conditional

Condition: 'ohlc' channel only.

Unsubscribe to a specific interval.

Example

{
  "event": "unsubscribe",
  "pair": [
    "XBT/EUR",
    "XBT/USD"
  ],
  "subscription": {
    "name": "ticker"
  }
}