Skip to main content

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.

This generated page keeps Data Catalog export schema keys machine-backed without publishing a separate public schema JSON catalog. Use /export-schemas for human buying guidance and this page for JSON Schema browsing.
Schema keyLabelCoverage keyPricing unitMinimum
fundingFunding Ratesfunding$3/GB$5 minimum
l2_orderbookL2 Order Bookorderbook$10/GB$10 minimum
l3_orderbookIndividual-Order Book (L3)l3_orderbook$10/GB$10 minimum
l4_orderbookOrder-Level Book (L4)l4_orderbook$16/GB$25 minimum
l4_ordersOrder Events / TP/SLl4_orders$16/GB$25 minimum
liquidationsLiquidationsliquidations$25/GB$25 minimum
oiOpen Interestoi$3/GB$5 minimum
tradesTradestrades$25/GB$15 minimum

Export Manifest JSON Schema

{
  "type": "object",
  "required": [
    "venue_family",
    "market",
    "schema_keys",
    "start_date_utc",
    "end_date_utc",
    "coverage_source",
    "estimated_size",
    "credits_or_cost",
    "delivery_status",
    "data_rights_decision"
  ],
  "properties": {
    "venue_family": {
      "type": "string",
      "enum": [
        "Hyperliquid core",
        "Hyperliquid Spot",
        "HIP-3",
        "HIP-4",
        "Lighter"
      ]
    },
    "market": {
      "type": "string",
      "description": "Market symbol, pair, builder-prefixed symbol, or outcome identifier."
    },
    "schema_keys": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "l2_orderbook",
          "l3_orderbook",
          "l4_orderbook",
          "l4_orders",
          "trades",
          "funding",
          "oi",
          "liquidations"
        ]
      },
      "minItems": 1
    },
    "start_date_utc": {
      "type": "string",
      "format": "date"
    },
    "end_date_utc": {
      "type": "string",
      "format": "date"
    },
    "coverage_source": {
      "type": "string",
      "description": "Coverage field or selected market row used to approve the range."
    },
    "estimated_size": {
      "type": "string",
      "description": "Estimated file size or GB estimate shown before checkout."
    },
    "credits_or_cost": {
      "type": "string",
      "description": "Quoted credits, dollar cost, or pricing-unit calculation."
    },
    "delivery_status": {
      "type": "string",
      "enum": [
        "estimated",
        "quoted",
        "checkout_opened",
        "paid",
        "processing",
        "delivered",
        "failed",
        "canceled"
      ]
    },
    "data_rights_decision": {
      "type": "string",
      "description": "Internal-use, derived-output, customer-facing, redistribution, or partner-feed decision."
    }
  },
  "additionalProperties": false
}

Funding Rates

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Funding Rates export schema selection",
  "type": "object",
  "required": [
    "schema_key",
    "label",
    "coverage_key",
    "pricing_unit",
    "minimum",
    "rough_columns",
    "venue_applicability",
    "date_range_constraints"
  ],
  "properties": {
    "schema_key": {
      "const": "funding",
      "description": "Data Catalog schema key selected for an export."
    },
    "label": {
      "const": "Funding Rates"
    },
    "coverage_key": {
      "const": "funding"
    },
    "pricing_unit": {
      "const": "$3/GB"
    },
    "minimum": {
      "const": "$5 minimum"
    },
    "rough_columns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "timestamp",
          "symbol",
          "funding_rate",
          "premium"
        ]
      ]
    },
    "venue_applicability": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "Hyperliquid core",
          "HIP-3",
          "Lighter"
        ]
      ]
    },
    "date_range_constraints": {
      "type": "string",
      "const": [
        "Use coverage_by_type.funding when present, otherwise coverage_from.",
        "Use UTC start and end dates.",
        "Funding exports are separate from open-interest and candle exports."
      ]
    }
  },
  "additionalProperties": false
}

L2 Order Book

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "L2 Order Book export schema selection",
  "type": "object",
  "required": [
    "schema_key",
    "label",
    "coverage_key",
    "pricing_unit",
    "minimum",
    "rough_columns",
    "venue_applicability",
    "date_range_constraints"
  ],
  "properties": {
    "schema_key": {
      "const": "l2_orderbook",
      "description": "Data Catalog schema key selected for an export."
    },
    "label": {
      "const": "L2 Order Book"
    },
    "coverage_key": {
      "const": "orderbook"
    },
    "pricing_unit": {
      "const": "$10/GB"
    },
    "minimum": {
      "const": "$10 minimum"
    },
    "rough_columns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "timestamp",
          "symbol",
          "bids",
          "asks",
          "mid_price",
          "spread"
        ]
      ]
    },
    "venue_applicability": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "Hyperliquid core",
          "Hyperliquid Spot",
          "HIP-3",
          "HIP-4",
          "Lighter"
        ]
      ]
    },
    "date_range_constraints": {
      "type": "string",
      "const": [
        "Use coverage_by_type.orderbook when present, otherwise coverage_from.",
        "Use UTC start and end dates.",
        "For settled HIP-4 outcomes, cap the export end date at coverage_to."
      ]
    }
  },
  "additionalProperties": false
}

Individual-Order Book (L3)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Individual-Order Book (L3) export schema selection",
  "type": "object",
  "required": [
    "schema_key",
    "label",
    "coverage_key",
    "pricing_unit",
    "minimum",
    "rough_columns",
    "venue_applicability",
    "date_range_constraints"
  ],
  "properties": {
    "schema_key": {
      "const": "l3_orderbook",
      "description": "Data Catalog schema key selected for an export."
    },
    "label": {
      "const": "Individual-Order Book (L3)"
    },
    "coverage_key": {
      "const": "l3_orderbook"
    },
    "pricing_unit": {
      "const": "$10/GB"
    },
    "minimum": {
      "const": "$10 minimum"
    },
    "rough_columns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "timestamp",
          "symbol",
          "individual_orders",
          "bid_count",
          "ask_count",
          "mid_price",
          "spread"
        ]
      ]
    },
    "venue_applicability": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "Lighter"
        ]
      ]
    },
    "date_range_constraints": {
      "type": "string",
      "const": [
        "Use coverage_by_type.l3_orderbook when present, otherwise coverage_from.",
        "Use UTC start and end dates.",
        "Keep L3 individual-order depth separate from L2 price-level snapshots."
      ]
    }
  },
  "additionalProperties": false
}

Order-Level Book (L4)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Order-Level Book (L4) export schema selection",
  "type": "object",
  "required": [
    "schema_key",
    "label",
    "coverage_key",
    "pricing_unit",
    "minimum",
    "rough_columns",
    "venue_applicability",
    "date_range_constraints"
  ],
  "properties": {
    "schema_key": {
      "const": "l4_orderbook",
      "description": "Data Catalog schema key selected for an export."
    },
    "label": {
      "const": "Order-Level Book (L4)"
    },
    "coverage_key": {
      "const": "l4_orderbook"
    },
    "pricing_unit": {
      "const": "$16/GB"
    },
    "minimum": {
      "const": "$25 minimum"
    },
    "rough_columns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "timestamp",
          "symbol",
          "user_address",
          "side",
          "price",
          "size",
          "change_type",
          "snapshots"
        ]
      ]
    },
    "venue_applicability": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "Hyperliquid core",
          "Hyperliquid Spot",
          "HIP-3"
        ]
      ]
    },
    "date_range_constraints": {
      "type": "string",
      "const": [
        "Use coverage_by_type.l4_orderbook when present, otherwise coverage_from.",
        "Use UTC start and end dates.",
        "Keep L4 book changes separate from order-event exports."
      ]
    }
  },
  "additionalProperties": false
}

Order Events / TP/SL

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Order Events / TP/SL export schema selection",
  "type": "object",
  "required": [
    "schema_key",
    "label",
    "coverage_key",
    "pricing_unit",
    "minimum",
    "rough_columns",
    "venue_applicability",
    "date_range_constraints"
  ],
  "properties": {
    "schema_key": {
      "const": "l4_orders",
      "description": "Data Catalog schema key selected for an export."
    },
    "label": {
      "const": "Order Events / TP/SL"
    },
    "coverage_key": {
      "const": "l4_orders"
    },
    "pricing_unit": {
      "const": "$16/GB"
    },
    "minimum": {
      "const": "$25 minimum"
    },
    "rough_columns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "timestamp",
          "symbol",
          "user_address",
          "order_id",
          "status",
          "side",
          "price",
          "size",
          "order_type"
        ]
      ]
    },
    "venue_applicability": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "Hyperliquid core",
          "Hyperliquid Spot",
          "HIP-3"
        ]
      ]
    },
    "date_range_constraints": {
      "type": "string",
      "const": [
        "Use coverage_by_type.l4_orders when present, otherwise coverage_from.",
        "Use UTC start and end dates.",
        "Preserve TP/SL and order lifecycle state separately from ordinary trade rows."
      ]
    }
  },
  "additionalProperties": false
}

Liquidations

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Liquidations export schema selection",
  "type": "object",
  "required": [
    "schema_key",
    "label",
    "coverage_key",
    "pricing_unit",
    "minimum",
    "rough_columns",
    "venue_applicability",
    "date_range_constraints"
  ],
  "properties": {
    "schema_key": {
      "const": "liquidations",
      "description": "Data Catalog schema key selected for an export."
    },
    "label": {
      "const": "Liquidations"
    },
    "coverage_key": {
      "const": "liquidations"
    },
    "pricing_unit": {
      "const": "$25/GB"
    },
    "minimum": {
      "const": "$25 minimum"
    },
    "rough_columns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "timestamp",
          "symbol",
          "liquidated_user",
          "price",
          "size",
          "side",
          "mark_price",
          "direction"
        ]
      ]
    },
    "venue_applicability": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "Hyperliquid core",
          "HIP-3"
        ]
      ]
    },
    "date_range_constraints": {
      "type": "string",
      "const": [
        "Use coverage_by_type.liquidations when present, otherwise coverage_from.",
        "Use UTC start and end dates.",
        "Do not request Hyperliquid core liquidations before 2025-03-22 through the export flow."
      ]
    }
  },
  "additionalProperties": false
}

Open Interest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Open Interest export schema selection",
  "type": "object",
  "required": [
    "schema_key",
    "label",
    "coverage_key",
    "pricing_unit",
    "minimum",
    "rough_columns",
    "venue_applicability",
    "date_range_constraints"
  ],
  "properties": {
    "schema_key": {
      "const": "oi",
      "description": "Data Catalog schema key selected for an export."
    },
    "label": {
      "const": "Open Interest"
    },
    "coverage_key": {
      "const": "oi"
    },
    "pricing_unit": {
      "const": "$3/GB"
    },
    "minimum": {
      "const": "$5 minimum"
    },
    "rough_columns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "timestamp",
          "symbol",
          "open_interest",
          "mark_price",
          "oracle_price"
        ]
      ]
    },
    "venue_applicability": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "Hyperliquid core",
          "HIP-3",
          "HIP-4",
          "Lighter"
        ]
      ]
    },
    "date_range_constraints": {
      "type": "string",
      "const": [
        "Use coverage_by_type.oi when present, otherwise coverage_by_type.open_interest or coverage_from.",
        "Use UTC start and end dates.",
        "HIP-4 price fields are probability-like values, not USD prices."
      ]
    }
  },
  "additionalProperties": false
}

Trades

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Trades export schema selection",
  "type": "object",
  "required": [
    "schema_key",
    "label",
    "coverage_key",
    "pricing_unit",
    "minimum",
    "rough_columns",
    "venue_applicability",
    "date_range_constraints"
  ],
  "properties": {
    "schema_key": {
      "const": "trades",
      "description": "Data Catalog schema key selected for an export."
    },
    "label": {
      "const": "Trades"
    },
    "coverage_key": {
      "const": "trades"
    },
    "pricing_unit": {
      "const": "$25/GB"
    },
    "minimum": {
      "const": "$15 minimum"
    },
    "rough_columns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "timestamp",
          "symbol",
          "side",
          "price",
          "size",
          "trade_id",
          "user_address",
          "fee",
          "direction"
        ]
      ]
    },
    "venue_applicability": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "enum": [
        [
          "Hyperliquid core",
          "Hyperliquid Spot",
          "HIP-3",
          "HIP-4",
          "Lighter"
        ]
      ]
    },
    "date_range_constraints": {
      "type": "string",
      "const": [
        "Use coverage_by_type.trades when present, otherwise coverage_from.",
        "Use UTC start and end dates.",
        "Do not request Hyperliquid core trades, liquidations, or Hyperliquid Spot trades before 2025-03-22 through the export flow."
      ]
    }
  },
  "additionalProperties": false
}
Last modified on May 18, 2026