> ## 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 HIP-3 liquidation levels JSON Schema

> Get HIP-3 liquidation levels JSON Schema contract. Includes route metadata, request parameters, response statuses, examples, and JSON fields for implementation.

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-27 this path served a pending trigger-order map; that data now lives at /orders/\{symbol}/trigger-levels. For HIP-3, cross-margined exposure is reported in flagged\_notional and excluded from buckets.

## Route Metadata

| Field | Value |
| - | - |
| Method | `GET` |
| Path | `/v1/hyperliquid/hip3/liquidations/{symbol}/levels` |
| operationId | `getHip3LiquidationLevels` |
| Tag | HIP-3 - Liquidations |
| Family | HIP-3 |
| Deprecated or legacy | no |

## Human endpoint reference

Open [`GET /v1/hyperliquid/hip3/liquidations/{symbol}/levels`](/api-reference/hip-3--liquidations/get-hip-3-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": "getHip3LiquidationLevels path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "Trading pair symbol.",
      "type": "string",
      "example": "xyz:TSLA",
      "x-parameter-location": "path"
    }
  }
}
```

### Query Parameters

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

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3LiquidationLevels 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": 322.86,
    "snapshot_ts": "2026-08-02 18:46:43.000",
    "block_number": 1095610000,
    "total_long": 9707806.14,
    "total_short": 13189198.41,
    "flagged_notional": 15254536.42,
    "levels": [
      {
        "price": 293.8026,
        "long_notional": 221368.31,
        "short_notional": 0,
        "long_count": 64,
        "short_count": 0
      },
      {
        "price": 300.2598,
        "long_notional": 120836.17,
        "short_notional": 0,
        "long_count": 35,
        "short_count": 0
      },
      {
        "price": 306.717,
        "long_notional": 6712.26,
        "short_notional": 0,
        "long_count": 15,
        "short_count": 0
      },
      {
        "price": 313.1742,
        "long_notional": 0,
        "short_notional": 48.75,
        "long_count": 0,
        "short_count": 1
      },
      {
        "price": 319.6314,
        "long_notional": 0,
        "short_notional": 327341.3,
        "long_count": 0,
        "short_count": 10
      },
      {
        "price": 326.0886,
        "long_notional": 0,
        "short_notional": 3690.61,
        "long_count": 0,
        "short_count": 4
      },
      {
        "price": 332.5458,
        "long_notional": 0,
        "short_notional": 59987.71,
        "long_count": 0,
        "short_count": 10
      },
      {
        "price": 339.003,
        "long_notional": 0,
        "short_notional": 55121.89,
        "long_count": 0,
        "short_count": 3
      },
      {
        "price": 345.4602,
        "long_notional": 0,
        "short_notional": 461.37,
        "long_count": 0,
        "short_count": 3
      },
      {
        "price": 351.9174,
        "long_notional": 0,
        "short_notional": 374.52,
        "long_count": 0,
        "short_count": 4
      }
    ],
    "source": "histogram",
    "source_bin_width": 1.6143
  },
  "meta": {
    "count": 10,
    "request_id": "d4e5f6a7-b8c9-4012-bcde-0123456789ab"
  }
}
```

##### OpenAPI example: `raw`

```json theme={"theme":"github-dark"}
{
  "success": true,
  "data": {
    "mid_price": 318.98,
    "snapshot_ts": "2026-08-06 13:20:14.000",
    "block_number": 1100170000,
    "total_long": 9439936.86,
    "total_short": 12457314.46,
    "flagged_notional": 15437186.38,
    "levels": [
      {
        "price": 316.1092,
        "long_notional": 2947.38,
        "short_notional": 0,
        "long_count": 4,
        "short_count": 0
      },
      {
        "price": 316.7471,
        "long_notional": 5528.56,
        "short_notional": 0,
        "long_count": 6,
        "short_count": 0
      },
      {
        "price": 317.3851,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      },
      {
        "price": 318.0231,
        "long_notional": 2001.92,
        "short_notional": 0,
        "long_count": 4,
        "short_count": 0
      },
      {
        "price": 318.661,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      },
      {
        "price": 319.299,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      },
      {
        "price": 319.9369,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      },
      {
        "price": 320.5749,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      },
      {
        "price": 321.2129,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      },
      {
        "price": 321.8508,
        "long_notional": 0,
        "short_notional": 0,
        "long_count": 0,
        "short_count": 0
      }
    ],
    "source": "raw"
  },
  "meta": {
    "count": 10,
    "request_id": "c3d4e5f6-a7b8-4901-abcd-f0123456789a"
  }
}
```

### Status 400

Invalid request

#### application/json

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