Get Hyperliquid trigger levels JSON Schema

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidTriggerLevels query parameters",
  "type": "object",
  "properties": {
    "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": "getHyperliquidTriggerLevels response 200",
  "description": "API response containing the pending trigger-order map.",
  "type": "object",
  "properties": {
    "data": {
      "description": "Currently pending stop-loss and take-profit trigger orders grouped into price buckets around the current mid/mark price. Voluntary trigger orders, not projected forced liquidations.",
      "type": "object",
      "required": [
        "as_of",
        "levels",
        "mid_price",
        "total_ask_size",
        "total_bid_size"
      ],
      "properties": {
        "as_of": {
          "description": "UTC RFC3339 server time the pending-trigger state was read. The map is current-state; use this to detect staleness.",
          "type": "string"
        },
        "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": {
          "description": "Current mid/mark price, center of the requested range.",
          "type": "number"
        },
        "total_ask_size": {
          "description": "Total pending ask size across the returned window.",
          "type": "number"
        },
        "total_bid_size": {
          "description": "Total pending bid size across the returned window.",
          "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
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidTriggerLevels response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "param": "limit",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05",
  "success": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidTriggerLevels response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

{
  "code": 401,
  "error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
  "error_code": "unauthorized",
  "request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
  "success": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidTriggerLevels response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

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