Blockchain.com · JSON Structure

Com Exchange L3Event Payload Structure

ExchangeL3EventPayload schema from Blockchain.com WebSocket APIs

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

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

Properties

seqnum event channel symbol bids asks

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-l3event-payload-structure.json",
  "name": "ExchangeL3EventPayload",
  "description": "ExchangeL3EventPayload schema from Blockchain.com WebSocket APIs",
  "type": "object",
  "properties": {
    "seqnum": {
      "type": "int32"
    },
    "event": {
      "type": "string",
      "enum": [
        "snapshot",
        "updated"
      ]
    },
    "channel": {
      "type": "string",
      "const": "l3"
    },
    "symbol": {
      "type": "string"
    },
    "bids": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "px",
          "qty"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Exchange order id."
          },
          "px": {
            "type": "double"
          },
          "qty": {
            "type": "double",
            "description": "Order size. 0 means remove the order."
          }
        }
      }
    },
    "asks": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "px",
          "qty"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "px": {
            "type": "double"
          },
          "qty": {
            "type": "double"
          }
        }
      }
    }
  },
  "required": [
    "seqnum",
    "event",
    "channel",
    "symbol",
    "bids",
    "asks"
  ]
}