Blockchain.com · JSON Structure

Com Exchange Subscribe Symbol Action Payload Structure

ExchangeSubscribeSymbolActionPayload schema from Blockchain.com WebSocket APIs

Type: object Properties: 3 Required: 3
CryptocurrencyBitcoinBlockchain DataExchangeMarket DataTradingPaymentsPublic APIs

ExchangeSubscribeSymbolActionPayload is a JSON Structure definition published by Blockchain.com, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

action channel symbol

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blockchain/refs/heads/main/json-structure/com-exchange-subscribe-symbol-action-payload-structure.json",
  "name": "ExchangeSubscribeSymbolActionPayload",
  "description": "ExchangeSubscribeSymbolActionPayload schema from Blockchain.com WebSocket APIs",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "subscribe",
        "unsubscribe"
      ]
    },
    "channel": {
      "type": "string",
      "enum": [
        "l2",
        "l3",
        "ticker",
        "trades"
      ]
    },
    "symbol": {
      "type": "string",
      "description": "Exchange symbol identifier, e.g. \"BTC-USD\"."
    }
  },
  "required": [
    "action",
    "channel",
    "symbol"
  ]
}