Dataset coverage
Entitlement-filtered source coverage and historical extent. Coverage is evidence of readiness, not a blanket promise of complete data. delay_seconds is null. Rows are ordered by exchange_mic, country_code, instrument_id and series_id. A dataset with nothing published is reported as rows with status unavailable, not refused. Default order: id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Never 501 or 503: a dataset with nothing published is reported as rows, implementation_status planned or availability unavailable in /v1/datasets and coverage status unavailable in /v1/datasets/{dataset}/coverage. Access requires the operation capability on the API key.
/v1/datasets/{dataset}/coverage- Required capability
- reference.read
- Data timing
- As published by the source
- Credits
- 5 credits per request.
Parameters
datasetstringrequired · path- Dataset slug: the path after /v1/ with / written as ., such as eod or financials.statements. An unknown slug, or one outside the key's capabilities, returns 404 dataset-not-found.
instrument_idsstringoptional · query- Filter by stable instrument IDs. IDs and symbols may not be combined.
symbolsstringoptional · query- Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined.
symbol_atstringoptional · query- Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.
countriesstringoptional · query- ISO 3166-1 alpha-2 country codes.
series_idsstringoptional · query- Series IDs.
as_ofstringoptional · query- Knowledge cutoff as a UTC date (YYYY-MM-DD) for the coverage of a research dataset; cannot be in the future. A date before the dataset's history returns no rows. For core datasets (those of the core endpoints, such as eod and quotes), and for bars while they are read from end-of-day prices, any as_of returns 422 point-in-time-unavailable.
limitintegeroptional · query- Maximum records per page.Default:
100 cursorstringoptional · query- Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.
formatstringoptional · query- Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.
jsoncsv
Response fields
Returns data as an array of records. All example values are illustrative.
datasetstring- Dataset slug.
asset_typestring · null- Asset type when applicable.
equityetfmutual_fundindexbondoptionforexcryptocommodity exchange_micstring · null- MIC if applicable.
country_codestring · null- country code
instrument_idstring · null- Opaque stable public identifier; never an internal database key.
series_idstring · null- Series identifier.
history_fromstring · null- First date of the scope's history, where known. For calendar, the first exchange-local date /v1/calendar answers for the exchange.
history_tostring · null- Last date of the scope's history, where known. For calendar, the last exchange-local date /v1/calendar answers for the exchange, which is ahead of today; null for a venue that trades continuously, whose calendar has no last date.
knowledge_fromstring · null- knowledge from
latest_event_atstring · null- latest event at
checked_atstring- checked at
statusstring- Readiness for this scope.
unavailablepartialready reasonstring · null- Coverage limitation.
delay_secondsinteger · null- Expected delivery delay.
intervalsarray- intervals
gapsobject · null- Interior gaps in end-of-day history: open exchange sessions between the first and last bar that have no bar. Measured for eod (and bars served from it) per instrument; null for other datasets and scopes, and for an instrument whose gaps the request had no time left to measure (its reason says so; measurements are cached, so repeating the request reports them).
Response metadata
Responses include meta.timezone. Dataset responses include next_cursor; health and exports have their own metadata. Request tracing uses the X-Request-ID header.
When something goes wrong
An empty data: [] is a successful query with no matching records. Invalid symbols, permissions and malformed parameters produce an RFC 9457 problem with an actionable detail.
Plans
Requires reference.read. Access, recency and history depth come from the plan definitions the API enforces.
| Plan | Access | Recency | History |
|---|---|---|---|
| Free | Included | As published | Not date-bounded |
| Developer | Included | As published | Not date-bounded |
| Pro | Included | As published | Not date-bounded |
| Commercial | Included | As published | Not date-bounded |
| Scale | Included | As published | Not date-bounded |
Free requests are limited to AAPL, NVDA, JNJ, PEP, MSFT, SPY, QQQ.
History is how far back a plan may request. How far records actually go for a symbol is history_from in dataset coverage. Nothing is real-time. Compare plans