Order Book Depth (Bids & Asks) by Exchange & Pair

{
  "type": "object",
  "required": [
    "pair"
  ],
  "properties": {
    "pair": {
      "type": "string",
      "minLength": 1,
      "description": "Trading pair (e.g. BTC/USDT). Example: BTC/USDT."
    },
    "type": {
      "enum": [
        "spot",
        "swap",
        "perpetual",
        "perp"
      ],
      "type": "string",
      "default": "spot",
      "description": "Market type: spot for spot trading, swap/perpetual/perp for perpetual contracts. Example: spot. Defaults to \"spot\"."
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1,
      "description": "Number of price levels (1-100). Example: 20. Defaults to 20."
    },
    "exchange": {
      "enum": [
        "binance",
        "okx",
        "bybit",
        "bitget",
        "coinbase",
        "kraken",
        "gate",
        "mexc",
        "upbit",
        "bitstamp",
        "deribit",
        "bitmex",
        "bithumb",
        "hyperliquid"
      ],
      "type": "string",
      "default": "binance",
      "description": "Exchange identifier. Note: hyperliquid uses USDC-settled perps (e.g. BTC/USDC:USDC); pass USDC-quoted pairs when querying hyperliquid. Example: binance. Defaults to \"binance\"."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "asks": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "price": {
                  "type": "number",
                  "description": "Ask price per unit of the base asset."
                },
                "amount": {
                  "type": "number",
                  "description": "Quantity available at this ask price, in the base asset."
                }
              },
              "additionalProperties": false
            },
            "description": "20 ask levels on both fixtures (the default limit of 20)."
          },
          "bids": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "price": {
                  "type": "number",
                  "description": "Bid price per unit of the base asset."
                },
                "amount": {
                  "type": "number",
                  "description": "Quantity available at this bid price, in the base asset."
                }
              },
              "additionalProperties": false
            },
            "description": "20 bid levels on both fixtures (the default limit of 20)."
          },
          "pair": {
            "type": "string",
            "description": "Echoes the requested trading pair, normalized to base/quote -- the hyperliquid fixture requested 'BTC/USDC:USDC' and reports pair as 'BTC/USDC'."
          },
          "spread": {
            "type": "number",
            "description": "Absolute gap between the best bid and best ask in quote-price terms. Observed 0.01 on the binance spot fixture and 1.0 on the hyperliquid perpetual fixture."
          },
          "exchange": {
            "type": "string",
            "description": "Echoes the requested exchange."
          },
          "ask_depth": {
            "type": "number",
            "description": "Sum of all returned ask amounts (base asset)."
          },
          "bid_depth": {
            "type": "number",
            "description": "Sum of all returned bid amounts (base asset)."
          },
          "mid_price": {
            "type": "number",
            "description": "Midpoint between the best bid and the best ask."
          },
          "spread_pct": {
            "type": "number",
            "description": "The spread relative to the mid price, as a fraction -- 0.0000118 on the binance fixture (tight spot book) versus 0.00118 on the hyperliquid fixture."
          }
        },
        "additionalProperties": false
      },
      "description": "One entry per requested pair; a single entry on both fixtures observed."
    },
    "meta": {
      "type": "object",
      "properties": {
        "cached": {
          "type": "boolean",
          "description": "Whether this response was served from the provider's cache."
        }
      },
      "additionalProperties": false
    }
  },
  "description": "The order book response, as returned at routing.responseResultPath ($.output).",
  "additionalProperties": false
}