LiquidationLevelsData Schema

{
  "$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"
    }
  }
}