> ## 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 JSON Schema

> Get Hyperliquid liquidation levels JSON Schema contract. Includes parameters, response shapes, examples, and implementation notes from the 0xArchive contract.

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

Projected forced-liquidation levels computed from clearinghouse positions and margin state, aggregated into price buckets around the snapshot mark price. Snapshots are computed roughly every 5 minutes; the response's snapshot\_ts identifies the snapshot served. Historical snapshots are retained from 2026-07-27: use the at parameter for a point-in-time read, or the /history variant to enumerate snapshots with cursor pagination. Available on every plan; the endpoint carries a premium per-request credit cost. Note: before 2026-07-23 this path served a pending trigger-order map; that data now lives at /orders/\{symbol}/trigger-levels.

## Route Metadata

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

## Human endpoint reference

Open [`GET /v1/hyperliquid/liquidations/{symbol}/levels`](/api-reference/hyperliquid--liquidations/get-hyperliquid-liquidation-levels) 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": "getHyperliquidLiquidationLevels 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": "getHyperliquidLiquidationLevels 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"
    },
    "at": {
      "description": "Point-in-time read: epoch milliseconds (UTC). Serves the newest snapshot at or before this instant. Omit for the latest snapshot. History begins 2026-07-27; earlier instants return 404.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    }
  }
}
```

## Response Contracts

### Status 200

Get Hyperliquid liquidation levels

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidLiquidationLevels response 200",
  "description": "API response containing projected forced-liquidation levels for one snapshot.",
  "type": "object",
  "properties": {
    "data": {
      "description": "Projected forced-liquidation levels computed from clearinghouse positions and margin state (positions plus maintenance-margin tiers), aggregated into price buckets around the snapshot mark price. Snapshots are computed roughly every 5 minutes; snapshot_ts identifies the snapshot served.",
      "type": "object",
      "required": [
        "block_number",
        "flagged_notional",
        "levels",
        "mid_price",
        "snapshot_ts",
        "source",
        "total_long",
        "total_short"
      ],
      "properties": {
        "block_number": {
          "description": "Hyperliquid block height the snapshot reflects.",
          "type": "integer",
          "format": "int64"
        },
        "flagged_notional": {
          "description": "Notional reported in totals but computed approximately or not assigned to a returned bucket. For HIP-3, cross-margined exposure is reported here and excluded from buckets.",
          "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": {
          "description": "Mark price at the snapshot, center of the requested range.",
          "type": "number",
          "example": 64215
        },
        "snapshot_ts": {
          "description": "UTC snapshot time the levels reflect. Treat snapshots older than 2 hours as stale.",
          "type": "string"
        },
        "source": {
          "description": "Snapshot storage form used to answer the request. raw means query-time bins over stored fine-grained levels; histogram means proportional re-binning of a retained base histogram.",
          "type": "string",
          "enum": [
            "raw",
            "histogram"
          ]
        },
        "source_bin_width": {
          "description": "Stored source-bin width in price units. Present only when source is histogram.",
          "type": "number"
        },
        "total_long": {
          "description": "Total long notional at risk across the whole book, not only the returned window.",
          "type": "number"
        },
        "total_short": {
          "description": "Total short notional at risk across the whole book.",
          "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: `histogram`

```json theme={"theme":"github-dark"}
{
  "success": true,
  "data": {
    "mid_price": 63871,
    "snapshot_ts": "2026-08-02 16:25:06.000",
    "block_number": 1095490000,
    "total_long": 785802121.2,
    "total_short": 834739310.48,
    "flagged_notional": 0,
    "levels": [
      {
        "price": 58122.61,
        "long_notional": 83958706.7,
        "short_notional": 18054.42,
        "long_count": 1231,
        "short_count": 2
      },
      {
        "price": 59400.03,
        "long_notional": 73999154.77,
        "short_notional": 50.46,
        "long_count": 753,
        "short_count": 1
      },
      {
        "price": 60677.45,
        "long_notional": 47854533.03,
        "short_notional": 0,
        "long_count": 935,
        "short_count": 0
      },
      {
        "price": 61954.87,
        "long_notional": 39840093.21,
        "short_notional": 24801.11,
        "long_count": 2402,
        "short_count": 2
      },
      {
        "price": 63232.29,
        "long_notional": 1919748.29,
        "short_notional": 7224430.93,
        "long_count": 457,
        "short_count": 556
      },
      {
        "price": 64509.71,
        "long_notional": 90958.69,
        "short_notional": 57214522.14,
        "long_count": 4,
        "short_count": 1311
      },
      {
        "price": 65787.13,
        "long_notional": 5074713.82,
        "short_notional": 31458405.35,
        "long_count": 3,
        "short_count": 558
      },
      {
        "price": 67064.55,
        "long_notional": 1156673.15,
        "short_notional": 66646595.42,
        "long_count": 4,
        "short_count": 454
      },
      {
        "price": 68341.97,
        "long_notional": 434765.43,
        "short_notional": 107401882.13,
        "long_count": 10,
        "short_count": 992
      },
      {
        "price": 69619.39,
        "long_notional": 110833.43,
        "short_notional": 69719137.34,
        "long_count": 6,
        "short_count": 582
      }
    ],
    "source": "histogram",
    "source_bin_width": 319.355
  },
  "meta": {
    "count": 10,
    "request_id": "b2c3d4e5-f6a7-4890-9bcd-ef0123456789"
  }
}
```

##### OpenAPI example: `raw`

```json theme={"theme":"github-dark"}
{
  "success": true,
  "data": {
    "mid_price": 64234,
    "snapshot_ts": "2026-08-06 13:20:14.000",
    "block_number": 1100170000,
    "total_long": 826442891,
    "total_short": 940536199.24,
    "flagged_notional": 121607711.81,
    "levels": [
      {
        "price": 63655.89,
        "long_notional": 7411401.14,
        "short_notional": 0,
        "long_count": 190,
        "short_count": 0
      },
      {
        "price": 63784.36,
        "long_notional": 6715249.11,
        "short_notional": 0,
        "long_count": 458,
        "short_count": 0
      },
      {
        "price": 63912.83,
        "long_notional": 4028699.95,
        "short_notional": 0,
        "long_count": 344,
        "short_count": 0
      },
      {
        "price": 64041.3,
        "long_notional": 1387884.13,
        "short_notional": 0,
        "long_count": 171,
        "short_count": 0
      },
      {
        "price": 64169.77,
        "long_notional": 742482.09,
        "short_notional": 0,
        "long_count": 86,
        "short_count": 0
      },
      {
        "price": 64298.23,
        "long_notional": 0,
        "short_notional": 64234,
        "long_count": 0,
        "short_count": 1
      },
      {
        "price": 64426.7,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      },
      {
        "price": 64555.17,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      },
      {
        "price": 64683.64,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      },
      {
        "price": 64812.11,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      }
    ],
    "source": "raw"
  },
  "meta": {
    "count": 10,
    "request_id": "a1b2c3d4-e5f6-4789-8abc-def012345678"
  }
}
```

### Status 400

Invalid request

#### application/json

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