ApiResponseTriggerLevelsHistory Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResponseTriggerLevelsHistory",
  "description": "Paginated historical trigger-levels snapshots, ascending by snapshot_ts. When a page is full, meta.next_cursor carries the cursor for the next page.",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "description": "One historical trigger-levels snapshot (15-minute cadence). levels is omitted when summary=true.",
        "type": "object",
        "required": [
          "mid_price",
          "snapshot_ts",
          "total_ask_size",
          "total_bid_size"
        ],
        "properties": {
          "levels": {
            "type": "array",
            "items": {
              "description": "Aggregated currently open trigger orders at one rounded price bucket.",
              "type": "object",
              "required": [
                "ask_count",
                "ask_size",
                "bid_count",
                "bid_size",
                "price_bucket"
              ],
              "properties": {
                "ask_count": {
                  "description": "Number of ask-side trigger orders in the bucket.",
                  "type": "integer",
                  "format": "int64",
                  "example": 9
                },
                "ask_size": {
                  "description": "Ask-side trigger size in the bucket.",
                  "type": "number",
                  "example": 18.75
                },
                "bid_count": {
                  "description": "Number of bid-side trigger orders in the bucket.",
                  "type": "integer",
                  "format": "int64",
                  "example": 12
                },
                "bid_size": {
                  "description": "Bid-side trigger size in the bucket.",
                  "type": "number",
                  "example": 31.25
                },
                "price_bucket": {
                  "description": "Rounded trigger price bucket.",
                  "type": "number",
                  "example": 64200
                }
              }
            }
          },
          "mid_price": {
            "type": "number"
          },
          "snapshot_ts": {
            "type": "string"
          },
          "total_ask_size": {
            "type": "number"
          },
          "total_bid_size": {
            "type": "number"
          }
        }
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "coverage_from": {
          "description": "Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.",
          "type": "string",
          "format": "date-time"
        },
        "has_more": {
          "description": "Present on cursor-paged routes: true when another page exists. `next_cursor` is present exactly when it is true.",
          "type": "boolean"
        },
        "next_cursor": {
          "description": "Cursor for pagination (timestamp). Use this value as the `cursor` parameter to fetch the next page of results.",
          "type": "string",
          "nullable": true
        },
        "notice": {
          "description": "Human-readable advisory about the response. Used when the requested window ends before coverage begins for the symbol, and on CVD responses that are one page of several; may carry other advisories in future.",
          "type": "string"
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        },
        "symbol": {
          "description": "Present on per-symbol routes: the symbol the response covers.",
          "type": "string"
        },
        "venue": {
          "description": "Present on per-symbol routes: the venue the response covers, for example `hyperliquid` or `hip3`.",
          "type": "string"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}