Instruments

Parameters#

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.

asset_typestringoptional · query

Asset class.

equityetfmutual_fundcryptoforexindexbond

statusstringoptional · query

Default active. The security master was built in September 2026 from the listings its sources still carried and records delistings from then on, so nearly every delisted listing it holds stopped trading in 2026, and most issuers delisted earlier, such as TWTR or SIVB, are not held. all is therefore not a survivorship-free historical universe.

activedelistedexpiredinactiveall

countriesstringoptional · query

ISO 3166-1 alpha-2 country codes of the listing's exchange; with exchanges, the exchanges in these countries. The CRYPTO, FOREX, INDEX and BOND venues have no country (ZZ).

exchangesstringoptional · query

Listing MICs. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.

qstringoptional · query

Case-insensitive name or symbol search. Without order, the best matches come first: an exact ticker, then an exact name, then names that start with the text, then other matches, the most traded first within each. A value that is empty or only whitespace returns 422.

identifier_typestringoptional · query

Must be supplied together with identifier.

isincusipfigiciklei

identifierstringoptional · query

Exact identifier; requires identifier_type. May return multiple related listings. A CIK's leading zeroes are optional. Only listings with a provider profile match, so OTC listings, crypto and currency pairs, indices and bonds are not found this way (a bond is BOND:<ISIN> in symbols).

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.

known_fromstringoptional · query

First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.

known_tostringoptional · query

Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.

orderstringoptional · query

Direction on id; ties use ID ascending.

ascdesc

Default: asc

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.

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