> ## 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.

# LiquidationLevelsData Schema

> Projected forced-liquidation levels computed from clearinghouse positions and margin state (positions plus maintenance-margin tiers), aggregated into price.

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

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.

## Required Fields

| Field | Type | Description |
| - | - | - |
| `block_number` | integer:int64 | Hyperliquid block height the snapshot reflects. |
| `flagged_notional` | number | Notional reported in totals but computed approximately or not assigned to a returned bucket. |
| `levels` | array\<object> | Defined by the generated JSON Schema block. |
| `mid_price` | number | Mark price at the snapshot, center of the requested range. |
| `snapshot_ts` | string | UTC snapshot time the levels reflect. |
| `source` | string | Snapshot storage form used to answer the request. |
| `total_long` | number | Total long notional at risk across the whole book, not only the returned window. |
| `total_short` | number | Total short notional at risk across the whole book. |

## JSON Schema

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

## Referenced components

* [LiquidationLevelBucket](/schemas/components/liquidation-level-bucket)

## Components using this schema

* [ApiResponseLiquidationLevels](/schemas/components/api-response-liquidation-levels)

## Referenced By

Use this shared schema with the generated component index and route-specific endpoint pages during implementation.

## Operations using this component transitively

* [`GET /v1/hyperliquid/hip3/liquidations/{symbol}/levels`](/schemas/operations/get-hip3-liquidation-levels)
* [`GET /v1/hyperliquid/liquidations/{symbol}/levels`](/schemas/operations/get-hyperliquid-liquidation-levels)


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