Blockchain.com · Schema

ExchangeTradingSubscribePayload

ExchangeTradingSubscribePayload schema from Blockchain.com WebSocket APIs

CryptocurrencyBitcoinBlockchain DataExchangeMarket DataTradingPaymentsPublic APIs

Properties

Name Type Description
action string
channel string
cancelOnDisconnect boolean When true, cancels all live orders when the connection drops. Cannot be turned off once enabled.
View JSON Schema on GitHub

JSON Schema

com-exchange-trading-subscribe-payload-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blockchain/refs/heads/main/json-schema/com-exchange-trading-subscribe-payload-schema.json",
  "title": "ExchangeTradingSubscribePayload",
  "description": "ExchangeTradingSubscribePayload schema from Blockchain.com WebSocket APIs",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "subscribe",
        "unsubscribe"
      ]
    },
    "channel": {
      "type": "string",
      "const": "trading"
    },
    "cancelOnDisconnect": {
      "type": "boolean",
      "description": "When true, cancels all live orders when the connection drops. Cannot be turned off once enabled."
    }
  },
  "required": [
    "action",
    "channel"
  ]
}