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.

Source OpenAPI: 0xArchive API 1.5.0; 116 paths; 90 component schemas. Use the JSON Schema block below for field-level types, required fields, nested objects, and enum values.

Required Fields

No required fields are declared on this component schema.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResponseSpotFreshness",
  "type": "object",
  "properties": {
    "data": {
      "description": "Freshness state for a Hyperliquid Spot pair.",
      "type": "object",
      "required": [
        "coin",
        "exchange",
        "measured_at",
        "symbol"
      ],
      "properties": {
        "coin": {
          "type": "string",
          "example": "HYPE-USDC"
        },
        "exchange": {
          "type": "string",
          "example": "spot"
        },
        "l4_checkpoints": {
          "description": "Freshness state for one Hyperliquid Spot data type.",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Measured lag in milliseconds when available.",
              "type": "integer",
              "nullable": true,
              "example": 440
            },
            "last_updated": {
              "description": "Most recent update timestamp when available.",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-05-08T21:20:34.837Z"
            }
          },
          "additionalProperties": true
        },
        "l4_diffs": {
          "description": "Freshness state for one Hyperliquid Spot data type.",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Measured lag in milliseconds when available.",
              "type": "integer",
              "nullable": true,
              "example": 440
            },
            "last_updated": {
              "description": "Most recent update timestamp when available.",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-05-08T21:20:34.837Z"
            }
          },
          "additionalProperties": true
        },
        "measured_at": {
          "type": "string",
          "format": "date-time",
          "example": "2026-05-08T21:20:35.277945340Z"
        },
        "orderbook": {
          "description": "Freshness state for one Hyperliquid Spot data type.",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Measured lag in milliseconds when available.",
              "type": "integer",
              "nullable": true,
              "example": 440
            },
            "last_updated": {
              "description": "Most recent update timestamp when available.",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-05-08T21:20:34.837Z"
            }
          },
          "additionalProperties": true
        },
        "orders": {
          "description": "Freshness state for one Hyperliquid Spot data type.",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Measured lag in milliseconds when available.",
              "type": "integer",
              "nullable": true,
              "example": 440
            },
            "last_updated": {
              "description": "Most recent update timestamp when available.",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-05-08T21:20:34.837Z"
            }
          },
          "additionalProperties": true
        },
        "symbol": {
          "type": "string",
          "example": "HYPE-USDC"
        },
        "trades": {
          "description": "Freshness state for one Hyperliquid Spot data type.",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Measured lag in milliseconds when available.",
              "type": "integer",
              "nullable": true,
              "example": 440
            },
            "last_updated": {
              "description": "Most recent update timestamp when available.",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-05-08T21:20:34.837Z"
            }
          },
          "additionalProperties": true
        },
        "twap": {
          "description": "Freshness state for one Hyperliquid Spot data type.",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Measured lag in milliseconds when available.",
              "type": "integer",
              "nullable": true,
              "example": 440
            },
            "last_updated": {
              "description": "Most recent update timestamp when available.",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-05-08T21:20:34.837Z"
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "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
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

Referenced By

Last modified on May 18, 2026