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

# ApiResponseLiquidationLevels Schema

> API response containing projected forced-liquidation levels for one snapshot. Includes route metadata, schemas, examples, and implementation notes.

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

API response containing projected forced-liquidation levels for one snapshot.

## Required Fields

No required fields are declared on this component schema.

## JSON Schema

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

## Referenced components

* [ApiMeta](/schemas/components/api-meta)
* [LiquidationLevelsData](/schemas/components/liquidation-levels-data)

## Referenced By

* [`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.