Blockchain.com · Schema

OrderBook

Aggregated (L2) or per-order (L3) order book for a symbol.

CryptocurrencyBitcoinBlockchain DataExchangeMarket DataTradingPaymentsPublic APIs

Properties

Name Type Description
symbol string
bids array
asks array
View JSON Schema on GitHub

JSON Schema

exchange-order-book-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/exchange-order-book-schema.json",
  "title": "OrderBook",
  "description": "Aggregated (L2) or per-order (L3) order book for a symbol.",
  "type": "object",
  "properties": {
    "symbol": {
      "type": "string",
      "example": "BTC-USD"
    },
    "bids": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "One side of the order book at a single price.",
        "properties": {
          "px": {
            "type": "number",
            "description": "Price.",
            "example": 72525.0
          },
          "qty": {
            "type": "number",
            "description": "Quantity available at this price.",
            "example": 0.5
          },
          "num": {
            "type": "integer",
            "description": "Number of orders at this price (L2 only)."
          }
        }
      }
    },
    "asks": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "One side of the order book at a single price.",
        "properties": {
          "px": {
            "type": "number",
            "description": "Price.",
            "example": 72525.0
          },
          "qty": {
            "type": "number",
            "description": "Quantity available at this price.",
            "example": 0.5
          },
          "num": {
            "type": "integer",
            "description": "Number of orders at this price (L2 only)."
          }
        }
      }
    }
  }
}