Instrument identifiers
External identifiers of a listing as its provider profile states them: ISIN, CUSIP and FIGI identify the listing, CIK and LEI its issuer. valid_from and valid_to are null, since the source does not date them, and effective_date does not narrow the list; as_of bounds when an identifier became known. The security master's CIK and FIGI links are in /v1/tickers. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key.
/v1/instruments/{instrument_id}/identifiers- Required capability
- instruments.read
- Data timing
- As published by the source
- Credits
- 5 credits per request.
Parameters
instrument_idstringrequired · path- Stable public identifier.
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.
Default:ascdescasc 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- Record identifier, stable across revisions.
instrument_idstring- Opaque stable public identifier; never an internal database key.
typestring- Identifier namespace. CIK/LEI may identify the linked issuer rather than a listing.
isincusipfigiciklei valuestring- Identifier, preserving leading zeroes.
entity_typestring- Entity identified.
instrumentcompany company_idstring · null- Opaque stable public identifier; never an internal database key.
valid_fromstring · null- valid from
valid_tostring · null- valid to
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.
| Plan | Access | Recency | History |
|---|---|---|---|
| Free | Included | As published | 5 years |
| Developer | Included | As published | 5 years |
| Pro | Included | As published | 15 years |
| Commercial | Included | As published | Full history |
| Scale | Included | As published | Full history |
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