Blockchain.com · Schema

ExchangeSymbolsSnapshotPayload

ExchangeSymbolsSnapshotPayload schema from Blockchain.com WebSocket APIs

CryptocurrencyBitcoinBlockchain DataExchangeMarket DataTradingPaymentsPublic APIs

Properties

Name Type Description
seqnum integer
event string
channel string
symbols object
View JSON Schema on GitHub

JSON Schema

com-exchange-symbols-snapshot-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-symbols-snapshot-payload-schema.json",
  "title": "ExchangeSymbolsSnapshotPayload",
  "description": "ExchangeSymbolsSnapshotPayload schema from Blockchain.com WebSocket APIs",
  "type": "object",
  "properties": {
    "seqnum": {
      "type": "integer"
    },
    "event": {
      "type": "string",
      "const": "snapshot"
    },
    "channel": {
      "type": "string",
      "const": "symbols"
    },
    "symbols": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "base_currency": {
            "type": "string"
          },
          "base_currency_scale": {
            "type": "integer"
          },
          "counter_currency": {
            "type": "string"
          },
          "counter_currency_scale": {
            "type": "integer"
          },
          "min_price_increment": {
            "type": "integer"
          },
          "min_price_increment_scale": {
            "type": "integer"
          },
          "min_order_size": {
            "type": "integer"
          },
          "min_order_size_scale": {
            "type": "integer"
          },
          "max_order_size": {
            "type": "integer"
          },
          "max_order_size_scale": {
            "type": "integer"
          },
          "lot_size": {
            "type": "integer"
          },
          "lot_size_scale": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "close",
              "closed",
              "suspend",
              "halt",
              "halt-freeze"
            ]
          },
          "id": {
            "type": "integer"
          },
          "auction_price": {
            "type": "number"
          },
          "auction_size": {
            "type": "number"
          },
          "auction_time": {
            "type": "string"
          },
          "imbalance": {
            "type": "number"
          }
        }
      }
    }
  },
  "required": [
    "seqnum",
    "event",
    "channel",
    "symbols"
  ]
}