Get HIP-3 trigger levels history JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3TriggerLevelsHistory path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "Trading pair symbol.",
      "type": "string",
      "example": "xyz:TSLA",
      "x-parameter-location": "path"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3TriggerLevelsHistory query parameters",
  "type": "object",
  "properties": {
    "start": {
      "description": "Range start, epoch milliseconds inclusive. Default: 24 hours before end.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "end": {
      "description": "Range end, epoch milliseconds inclusive. Default: now.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "cursor": {
      "description": "Cursor from meta.next_cursor of the previous page (a snapshot_ts in epoch milliseconds, exclusive). The page continues strictly after it.",
      "type": "string",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Snapshots per page. Default 24, maximum 100. When a page is full, meta.next_cursor carries the cursor for the next page.",
      "type": "integer",
      "default": 24,
      "minimum": 1,
      "maximum": 100,
      "x-parameter-location": "query"
    },
    "summary": {
      "description": "When true, items contain snapshot_ts, mid price and totals only (no levels array). Cheap way to discover which snapshots exist before fetching full histograms.",
      "type": "boolean",
      "default": false,
      "x-parameter-location": "query"
    },
    "range_pct": {
      "description": "Percentage range around the snapshot mid/mark price. Clamped between 1 and 50. Default 10.",
      "type": "number",
      "default": 10,
      "minimum": 1,
      "maximum": 50,
      "x-parameter-location": "query"
    },
    "buckets": {
      "description": "Number of price buckets. Clamped between 10 and 200. Default 50.",
      "type": "integer",
      "default": 50,
      "minimum": 10,
      "maximum": 200,
      "x-parameter-location": "query"
    },
    "side": {
      "description": "Optional side filter. bid/buy/B keeps the long (or bid) side, ask/sell/A keeps the short (or ask) side; the other side is zeroed.",
      "type": "string",
      "enum": [
        "bid",
        "ask",
        "buy",
        "sell",
        "B",
        "A"
      ],
      "x-parameter-location": "query"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3TriggerLevelsHistory response 200",
  "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"
        },
        "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
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3TriggerLevelsHistory response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}

{
  "code": 400,
  "error": "Invalid request parameters"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3TriggerLevelsHistory response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3TriggerLevelsHistory response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}