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; 92 component schemas. Data freshness for all data types for a specific HIP-3 builder-perp symbol.

Required Fields

FieldTypeDescription
coinstringHIP-3 builder-perp symbol (deprecated, use symbol instead).
exchangestringVenue-family key for HIP-3 builder perps.
measured_atstring:date-timeWhen the freshness was measured.
symbolstringHIP-3 builder-perp symbol.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Hip3CoinFreshness",
  "description": "Data freshness for all data types for a specific HIP-3 builder-perp symbol.",
  "type": "object",
  "required": [
    "coin",
    "exchange",
    "measured_at",
    "symbol"
  ],
  "properties": {
    "coin": {
      "description": "HIP-3 builder-perp symbol (deprecated, use symbol instead).",
      "type": "string",
      "deprecated": true,
      "example": "km:US500"
    },
    "exchange": {
      "description": "Venue-family key for HIP-3 builder perps.",
      "type": "string",
      "example": "hip3"
    },
    "funding": {
      "description": "Freshness information for a single data type",
      "type": "object",
      "properties": {
        "lag_ms": {
          "description": "Current lag in milliseconds between now and last update",
          "type": "integer",
          "nullable": true,
          "example": 1200
        },
        "last_updated": {
          "description": "When this data type was last updated for the coin",
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "example": "2026-02-23T12:00:00.000Z"
        }
      }
    },
    "liquidations": {
      "description": "Freshness information for a single data type",
      "type": "object",
      "properties": {
        "lag_ms": {
          "description": "Current lag in milliseconds between now and last update",
          "type": "integer",
          "nullable": true,
          "example": 1200
        },
        "last_updated": {
          "description": "When this data type was last updated for the coin",
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "example": "2026-02-23T12:00:00.000Z"
        }
      }
    },
    "measured_at": {
      "description": "When the freshness was measured.",
      "type": "string",
      "format": "date-time",
      "example": "2026-05-27T01:41:51.111819220Z"
    },
    "open_interest": {
      "description": "Freshness information for a single data type",
      "type": "object",
      "properties": {
        "lag_ms": {
          "description": "Current lag in milliseconds between now and last update",
          "type": "integer",
          "nullable": true,
          "example": 1200
        },
        "last_updated": {
          "description": "When this data type was last updated for the coin",
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "example": "2026-02-23T12:00:00.000Z"
        }
      }
    },
    "orderbook": {
      "description": "Freshness information for a single data type",
      "type": "object",
      "properties": {
        "lag_ms": {
          "description": "Current lag in milliseconds between now and last update",
          "type": "integer",
          "nullable": true,
          "example": 1200
        },
        "last_updated": {
          "description": "When this data type was last updated for the coin",
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "example": "2026-02-23T12:00:00.000Z"
        }
      }
    },
    "symbol": {
      "description": "HIP-3 builder-perp symbol. Case-sensitive; keep the builder prefix intact.",
      "type": "string",
      "example": "km:US500"
    },
    "trades": {
      "description": "Freshness information for a single data type",
      "type": "object",
      "properties": {
        "lag_ms": {
          "description": "Current lag in milliseconds between now and last update",
          "type": "integer",
          "nullable": true,
          "example": 1200
        },
        "last_updated": {
          "description": "When this data type was last updated for the coin",
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "example": "2026-02-23T12:00:00.000Z"
        }
      }
    }
  }
}

Referenced By

Use this shared schema with the generated component index and route-specific endpoint pages during implementation.
Last modified on May 27, 2026