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. Get data coverage for a specific symbol on an exchange, including gap detection showing periods where data may be missing. Supports optional from/to query params (Unix ms) to bound the gap detection window (default: last 30 days). Returns empirical data cadence when sufficient data is available. Historical coverage uses hour-level granularity. Note: May take 30-60 seconds on first request (gap detection results are cached server-side for 1 hour).

​
Route Metadata

FieldValue
MethodGET
Path/v1/data-quality/coverage/{exchange}/{symbol}
operationIdgetSymbolCoverage
TagData Quality
FamilyData Quality
Deprecated or legacyno

​
Request Parameters

​
Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getSymbolCoverage path parameters",
  "type": "object",
  "required": [
    "exchange",
    "symbol"
  ],
  "properties": {
    "exchange": {
      "description": "Exchange name",
      "type": "string",
      "enum": [
        "hyperliquid",
        "lighter",
        "hip3"
      ],
      "example": "hyperliquid",
      "x-parameter-location": "path"
    },
    "symbol": {
      "description": "Symbol name (e.g., BTC, ETH)",
      "type": "string",
      "example": "BTC",
      "x-parameter-location": "path"
    }
  }
}

​
Query Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getSymbolCoverage query parameters",
  "type": "object",
  "properties": {
    "from": {
      "description": "Start of gap detection window (Unix milliseconds). Default: now - 30 days.",
      "type": "integer",
      "format": "int64",
      "example": 1704067200000,
      "x-parameter-location": "query"
    },
    "to": {
      "description": "End of gap detection window (Unix milliseconds). Default: now.",
      "type": "integer",
      "format": "int64",
      "example": 1706745600000,
      "x-parameter-location": "query"
    }
  }
}

​
Response Contracts

​
Status 200

Symbol coverage with gaps

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getSymbolCoverage response 200",
  "description": "Per-symbol coverage response with gap detection",
  "type": "object",
  "required": [
    "data_types",
    "exchange",
    "symbol"
  ],
  "properties": {
    "data_types": {
      "type": "object",
      "additionalProperties": {
        "description": "Coverage for a symbol and data type",
        "type": "object",
        "required": [
          "completeness",
          "earliest",
          "gaps",
          "latest",
          "total_records"
        ],
        "properties": {
          "cadence": {
            "description": "Empirical data cadence measurement (present when sufficient data exists)",
            "nullable": true,
            "allOf": [
              {
                "description": "Empirical data cadence measurement based on last 7 days of data",
                "type": "object",
                "required": [
                  "median_interval_seconds",
                  "p95_interval_seconds",
                  "sample_count"
                ],
                "properties": {
                  "median_interval_seconds": {
                    "description": "Median interval between consecutive records in seconds",
                    "type": "number"
                  },
                  "p95_interval_seconds": {
                    "description": "95th percentile interval between consecutive records in seconds",
                    "type": "number"
                  },
                  "sample_count": {
                    "description": "Number of intervals sampled for this measurement",
                    "type": "integer",
                    "format": "int64"
                  }
                }
              }
            ]
          },
          "completeness": {
            "description": "24-hour completeness percentage (0-100)",
            "type": "number"
          },
          "earliest": {
            "type": "string",
            "format": "date-time"
          },
          "gaps": {
            "description": "Detected data gaps within the requested time window",
            "type": "array",
            "items": {
              "description": "A gap in data coverage",
              "type": "object",
              "required": [
                "duration_minutes",
                "end",
                "start"
              ],
              "properties": {
                "duration_minutes": {
                  "description": "Gap duration in minutes",
                  "type": "integer"
                },
                "end": {
                  "description": "End of gap (first data after gap)",
                  "type": "string",
                  "format": "date-time"
                },
                "start": {
                  "description": "Start of gap (last data before gap)",
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "historical_coverage": {
            "description": "Historical coverage percentage (0-100) based on hours with data / total hours in range",
            "type": "number",
            "nullable": true
          },
          "latest": {
            "type": "string",
            "format": "date-time"
          },
          "total_records": {
            "type": "integer",
            "format": "int64"
          }
        }
      }
    },
    "exchange": {
      "description": "Exchange name",
      "type": "string"
    },
    "symbol": {
      "description": "Symbol name",
      "type": "string"
    }
  }
}

​
Status 400

Invalid request

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getSymbolCoverage response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 400,
  "error": "Invalid request parameters"
}

​
Status 401

Authentication required

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getSymbolCoverage response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

​
Status 404

Resource not found

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getSymbolCoverage response 404",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 404,
  "error": "Resource not found"
}
Last modified on May 18, 2026