Subscription Status

{
  "channelID": 10001,
  "channelName": "ticker",
  "event": "subscriptionStatus",
  "pair": "XBT/EUR",
  "status": "subscribed",
  "subscription": {
    "name": "ticker"
  }
}

{
  "channelID": 10001,
  "channelName": "ohlc-5",
  "event": "subscriptionStatus",
  "pair": "XBT/EUR",
  "reqid": 42,
  "status": "unsubscribed",
  "subscription": {
    "interval": 5,
    "name": "ohlc"
  }
}

{
  "channelName": "ownTrades",
  "event": "subscriptionStatus",
  "status": "subscribed",
  "subscription": {
    "name": "ownTrades"
  }
}

{
  "errorMessage": "Subscription depth not supported",
  "event": "subscriptionStatus",
  "pair": "XBT/USD",
  "status": "error",
  "subscription": {
    "depth": 42,
    "name": "book"
  }
}

{
  "channelID": 10001,
  "channelName": "ticker",
  "event": "subscriptionStatus",
  "pair": "XBT/EUR",
  "status": "subscribed",
  "subscription": {
    "name": "ticker"
  }
}

{
  "channelID": 10001,
  "channelName": "ohlc-5",
  "event": "subscriptionStatus",
  "pair": "XBT/EUR",
  "reqid": 42,
  "status": "unsubscribed",
  "subscription": {
    "interval": 5,
    "name": "ohlc"
  }
}

{
  "channelName": "ownTrades",
  "event": "subscriptionStatus",
  "status": "subscribed",
  "subscription": {
    "name": "ownTrades"
  }
}

{
  "errorMessage": "Subscription depth not supported",
  "event": "subscriptionStatus",
  "pair": "XBT/USD",
  "status": "error",
  "subscription": {
    "depth": 42,
    "name": "book"
  }
}

Subscription status response to subscribe, unsubscribe or exchange-initiated unsubscribe. This message is returned for every subscribe or unsubscribe request across all channels.

Payload

string

Value: subscriptionStatus

string

required

One of: book, ohlc, openOrders, ownTrades, spread, ticker, trade, *The name of the channel.

string

Example: "BTC/USD"The currency pair associated with this subscription.

string

One of: subscribed, unsubscribed, ok, error

object

Hide properties

integer

Condition: ‘book’ channel onlyThe book depth.

integer

Condition: ‘ohlc’ channel onlyThe ohlc interval.

integer

The rate counter.

string

required

One of: book, ohlc, openOrders, ownTrades, spread, ticker, trade, *The name of the channel.

string

Condition: Authenticated requests onlyThe authentication token associated with the request.

integer

Client originated identifier for the request that initiated this response.

string

Condition: Unsuccessful requests onlyError message for unsuccessful requests.

integer

deprecated

Deprecated: use channelName and pairChannel ID on successful subscription, applicable to public messages only.

⌘I

Public Channels

Trading

Account

System

Payload

​Payload

Payload