> ## 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.

# Get symbol coverage with gaps JSON Schema

> Get symbol coverage with gaps JSON Schema contract. Includes parameters, response shapes, examples, and implementation notes from the 0xArchive contract.

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas.

Get data coverage for a specific symbol under a venue-family key recognized by this route, 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

| Field | Value |
| - | - |
| Method | `GET` |
| Path | `/v1/data-quality/coverage/{exchange}/{symbol}` |
| operationId | `getSymbolCoverage` |
| Tag | Data Quality |
| Family | Data Quality |
| Deprecated or legacy | no |

## Human endpoint reference

Open [`GET /v1/data-quality/coverage/{exchange}/{symbol}`](/api-reference/data-quality/get-symbol-coverage-with-gaps) for authentication, parameters, responses, and examples.

## Implementation context

* [Data-quality preflight](/data-quality#check-one-window-before-use)

## Request Parameters

### Path Parameters

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getSymbolCoverage path parameters",
  "type": "object",
  "required": [
    "exchange",
    "symbol"
  ],
  "properties": {
    "exchange": {
      "description": "Venue-family key recognized by this route, such as `hyperliquid`.",
      "type": "string",
      "enum": [
        "hyperliquid",
        "lighter",
        "hip3",
        "spot",
        "hip4"
      ],
      "example": "hyperliquid",
      "x-parameter-location": "path"
    },
    "symbol": {
      "description": "Symbol name (e.g., BTC, ETH)",
      "type": "string",
      "example": "BTC",
      "x-parameter-location": "path"
    }
  }
}
```

### Query Parameters

```json theme={"theme":"github-dark"}
{
  "$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

```json theme={"theme":"github-dark"}
{
  "$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": "Venue-family key recognized by this route, such as `hyperliquid`.",
      "type": "string"
    },
    "symbol": {
      "description": "Symbol name",
      "type": "string"
    }
  }
}
```

### Status 400

Invalid request

#### application/json

```json theme={"theme":"github-dark"}
{
  "$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"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "param": "limit",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05",
  "success": false
}
```

### Status 401

Authentication required

#### application/json

```json theme={"theme":"github-dark"}
{
  "$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"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 401,
  "error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
  "error_code": "unauthorized",
  "request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
  "success": false
}
```

### Status 404

Resource not found

#### application/json

```json theme={"theme":"github-dark"}
{
  "$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"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 404,
  "error": "No L4 checkpoint available before requested timestamp",
  "error_code": "not_found",
  "request_id": "ad7df471-eb8a-477c-bd9f-c685a9825f5b",
  "success": false
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.