> ## Documentation Index
> Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Hyperliquid liquidation levels history JSON Schema

> Get Hyperliquid liquidation levels history JSON Schema contract. Includes route metadata, schemas, examples, and implementation notes.

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas.

Historical liquidation-levels snapshots (about every 5 minutes, retained from 2026-07-27), ascending by `snapshot_ts`. Cursor pagination: pass `start`/`end`/`limit` and follow `meta.next_cursor` as the `cursor` parameter. `summary=true` omits only `levels` while retaining `snapshot_ts`, `block_number`, `mid_price`, `total_long`, `total_short`, and `flagged_notional`.

## Route Metadata

| Field | Value |
| - | - |
| Method | `GET` |
| Path | `/v1/hyperliquid/liquidations/{symbol}/levels/history` |
| operationId | `getHyperliquidLiquidationLevelsHistory` |
| Tag | Hyperliquid - Liquidations |
| Family | Hyperliquid Core |
| Deprecated or legacy | no |

## Human endpoint reference

Open [`GET /v1/hyperliquid/liquidations/{symbol}/levels/history`](/api-reference/hyperliquid--liquidations/get-hyperliquid-liquidation-levels-history) for authentication, parameters, responses, and examples.

## Request Parameters

### Path Parameters

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

### Query Parameters

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidLiquidationLevelsHistory 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, omits only `levels` while retaining `snapshot_ts`, `block_number`, `mid_price`, `total_long`, `total_short`, and `flagged_notional`. 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"
    }
  }
}
```

## Response Contracts

### Status 200

Get Hyperliquid liquidation levels history

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidLiquidationLevelsHistory response 200",
  "description": "Paginated historical liquidation-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 liquidation-levels snapshot. levels is omitted when summary=true.",
        "type": "object",
        "required": [
          "block_number",
          "flagged_notional",
          "mid_price",
          "snapshot_ts",
          "total_long",
          "total_short"
        ],
        "properties": {
          "block_number": {
            "type": "integer",
            "format": "int64"
          },
          "flagged_notional": {
            "type": "number"
          },
          "levels": {
            "type": "array",
            "items": {
              "description": "One price bucket of projected forced-liquidation exposure.",
              "type": "object",
              "required": [
                "long_count",
                "long_notional",
                "price",
                "short_count",
                "short_notional"
              ],
              "properties": {
                "long_count": {
                  "description": "Number of long positions in this bucket.",
                  "type": "integer"
                },
                "long_notional": {
                  "description": "USD notional of long positions projected to liquidate in this bucket.",
                  "type": "number"
                },
                "price": {
                  "description": "Bucket center price.",
                  "type": "number"
                },
                "short_count": {
                  "description": "Number of short positions in this bucket.",
                  "type": "integer"
                },
                "short_notional": {
                  "description": "USD notional of short positions projected to liquidate in this bucket.",
                  "type": "number"
                }
              }
            }
          },
          "mid_price": {
            "type": "number"
          },
          "snapshot_ts": {
            "type": "string"
          },
          "total_long": {
            "type": "number"
          },
          "total_short": {
            "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
    }
  }
}
```

##### OpenAPI example: `historical`

```json theme={"theme":"github-dark"}
{
  "success": true,
  "data": [
    {
      "snapshot_ts": "2026-08-05 14:03:07.000",
      "block_number": 1099000000,
      "mid_price": 64281,
      "total_long": 792122474.4,
      "total_short": 875697280.92,
      "flagged_notional": 137629962.54,
      "levels": [
        {
          "price": 58495.71,
          "long_notional": 89531699.15,
          "short_notional": 0,
          "long_count": 1328,
          "short_count": 0
        },
        {
          "price": 59781.33,
          "long_notional": 25152539.49,
          "short_notional": 0,
          "long_count": 624,
          "short_count": 0
        },
        {
          "price": 61066.95,
          "long_notional": 37926175.04,
          "short_notional": 0,
          "long_count": 795,
          "short_count": 0
        },
        {
          "price": 62352.57,
          "long_notional": 26595035.98,
          "short_notional": 0,
          "long_count": 1019,
          "short_count": 0
        },
        {
          "price": 63638.19,
          "long_notional": 26376652.21,
          "short_notional": 0,
          "long_count": 1143,
          "short_count": 0
        },
        {
          "price": 64923.81,
          "long_notional": 0,
          "short_notional": 158162269.8,
          "long_count": 0,
          "short_count": 3049
        },
        {
          "price": 66209.43,
          "long_notional": 0,
          "short_notional": 42138204.92,
          "long_count": 0,
          "short_count": 1201
        },
        {
          "price": 67495.05,
          "long_notional": 0,
          "short_notional": 98948611.74,
          "long_count": 0,
          "short_count": 641
        },
        {
          "price": 68780.67,
          "long_notional": 0,
          "short_notional": 46481321.12,
          "long_count": 0,
          "short_count": 750
        },
        {
          "price": 70066.29,
          "long_notional": 0,
          "short_notional": 134790633.49,
          "long_count": 0,
          "short_count": 1031
        }
      ]
    }
  ],
  "meta": {
    "count": 1,
    "next_cursor": null,
    "request_id": "e5f6a7b8-c9d0-4123-8def-123456789abc"
  }
}
```

### Status 400

Invalid request

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidLiquidationLevelsHistory 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
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "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
}
```

### Status 401

Authentication required

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidLiquidationLevelsHistory 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
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "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
}
```

### Status 429

Rate limit exceeded

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidLiquidationLevelsHistory 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
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 429,
  "error": "Rate limit exceeded"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.