Blockchain.com · JSON Structure

Com Exchange Symbol Update Payload Structure

ExchangeSymbolUpdatePayload schema from Blockchain.com WebSocket APIs

Type: object Properties: 9 Required: 5
CryptocurrencyBitcoinBlockchain DataExchangeMarket DataTradingPaymentsPublic APIs

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

Properties

seqnum event channel symbol auction-price auction-size auction-time imbalance status

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-symbol-update-payload-structure.json",
  "name": "ExchangeSymbolUpdatePayload",
  "description": "ExchangeSymbolUpdatePayload schema from Blockchain.com WebSocket APIs",
  "type": "object",
  "properties": {
    "seqnum": {
      "type": "int32"
    },
    "event": {
      "type": "string",
      "const": "updated"
    },
    "channel": {
      "type": "string",
      "const": "symbols"
    },
    "symbol": {
      "type": "string"
    },
    "auction-price": {
      "type": "double"
    },
    "auction-size": {
      "type": "double"
    },
    "auction-time": {
      "type": "string",
      "description": "Opening time in HHMM format when symbol is halted."
    },
    "imbalance": {
      "type": "double"
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "close",
        "closed",
        "suspend",
        "halt",
        "halt-freeze"
      ]
    }
  },
  "required": [
    "seqnum",
    "event",
    "channel",
    "symbol",
    "status"
  ]
}