Instruments by ID

Parameters#

effective_datestringoptional · query

Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.

as_ofstringoptional · query

Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.

idstringrequired · path

Stable public record ID.

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 object. All example values are illustrative.

idstring

Opaque stable public identifier; never an internal database key.

security_idstring · null

Existing OHLC security_id when applicable; identical to id for existing securities.Being superseded by instrument_id, which carries the same value. Read instrument_id where present; security_id remains for compatibility.

namestring

Instrument name.

asset_typestring

Instrument type.

equityetfmutual_fundindexbondoptionforexcryptocommodity

company_idstring · null

Opaque stable public identifier; never an internal database key.

symbolstring · null

MIC:TICKER; null for unlisted instruments.

exchange_micstring · null

exchange mic

currency_codestring · null

ISO 4217 currency. Crypto quote assets use instrument IDs, not invented ISO codes.

statusstring

Lifecycle state at effective_date. delisted: the listing no longer trades and its ticker has left the provider's symbol list. inactive: it has had no daily bar for a run of sessions after trading daily, while still listed; it becomes delisted once dropped, or active again when it trades.

activedelistedexpiredinactive

listed_onstring · null

listed on

delisted_onstring · null

Last date a delisted or inactive listing traded; null while active.

logo_urlstring · null

Logo hosted by OHLC for the listing's company, or for a fund without its own, its sponsor's: SVG when a vector logo exists, otherwise PNG. The URL changes when the logo changes, so it can be cached indefinitely.

base_instrument_idstring · null

For a crypto pair, its coin (instrument_id in /v1/crypto/assets); null otherwise.

quote_instrument_idstring · null

Always null: every crypto pair served is quoted in US dollars.

bondobject · null

bond

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 instruments.read. Access, recency and history depth come from the plan definitions the API enforces.

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