---
title: "Get Coverage"
method: GET
path: "/api/engine/coverage/{identifier}"
---

# Get Coverage

`GET /api/engine/coverage/{identifier}`

## Request

- Base URL: `https://basisprotocol.xyz` (the document declares no server; this is the origin it was published from)
- URL: `https://basisprotocol.xyz/api/engine/coverage/{identifier}`
- Auth: none declared

Return Basis's coverage of an entity across all indexes.

## Path parameters

- `identifier` string, required

## Query parameters

- `include_related` boolean
- `date_range_start` string, date, nullable
- `date_range_end` string, date, nullable

## Response `200`

Successful Response

- CoverageResponse
  - `identifier` string, required
  - `matched_entities` EntityCoverage[], required
    - `index_id` string, required
    - `entity_slug` string, required
    - `entity_name` string, nullable
    - `coverage_type` 'live' | 'backfilled' | 'sparse' | 'none', required
    - `live` boolean, required
    - `density` 'multiple_daily' | 'daily' | 'weekly' | 'sparse' | 'single', required
    - `earliest_record` string, date, nullable
    - `latest_record` string, date, nullable
    - `unique_days` integer, required
    - `days_since_last_record` integer, nullable
    - `coverage_window_days` integer, nullable
    - `data_source` string, required
    - `available_endpoints` string[]
  - `related_entities` RelatedEntity[], required
    - `index_id` string, required
    - `entity_slug` string, required
    - `relation` string, required
  - `adjacent_indexes_not_covering` string[], required
  - `coverage_summary` string, required
  - `coverage_quality` 'full-live' | 'partial-live' | 'partial-reconstructable' | 'sparse' | 'none', required
  - `recommended_analysis_types` string[], required
  - `blocks_incident_page` boolean, required
  - `blocks_reasons` string[], required
  - `data_snapshot_hash` string, required
  - `computed_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/basisprotocol/apis/basis-protocol-api.md) · [All operations](https://skmtc.dev/basisprotocol/apis/basis-protocol-api/llms.txt) · [OpenAPI document](https://skmtc.dev/basisprotocol/apis/basis-protocol-api/revisions/c0067366b9c0?raw)