Ticker profile

Retrieve one indexed ticker with its issuer's reference data and Atlas entity, and on view=full the same observed metadata as the Ticker Directory.

GET/api/v2.0/tickers/profile

Authorizations

Bearer

Authorizationstringheader

Required Bearer API key for programmatic World access.

Example: Bearer nos_sk_...

Parameters

query & path

viewenumquery

The records returned: lite (the default), each entity's or ticker's identity, event count, date range and events per year, enough to choose one and fetch its events; or full, which adds the facets and numeric statistics of its events and a ticker's complete reference data. Any other value is a 422 validation_error.

Example: lite

symbolstringrequiredquery

Ticker symbol or alternate identifier to look up.

Example: NVDA.US

id_typeenumquery

Identifier type: symbol, isin, figi, lei, or qid. Defaults to symbol.

Example: symbol

How to use this endpoint

guidance

In V2.0, the profile names the Atlas entity of the ticker's issuer in reference.entity. Use Ticker Profile for one known symbol or alternate identifier. The lite record (the default) has the ticker's identity, event count and events per year, and its issuer's name, identifiers, listing, country and Atlas entity in reference; view=full adds the observed metadata and the complete reference data.

Response body

application/json

These are the fields you can build against. Nested names use dot notation; optional sections are called out in their descriptions.

schemastring

Response schema name.

viewstring

The view of the records: lite (the default) or full.

profileobject

The ticker's identity, event count and date range.

profile.kindstring

ticker.

profile.typestring

TICKER.

profile.namestring

Symbol with its exchange suffix, such as NVDA.US.

profile.normalizedstring

Lower-cased lookup form of the name.

profile.total_eventsinteger

Indexed events matched to the ticker.

profile.first_datedate

Date of the earliest indexed event.

profile.last_datedate

Date of the latest indexed event.

profile.events_urlstring

The ticker's event timeline on this API version.

metadataobject

What the indexed events of this entity look like: events_by_year, and with view=full facets (the top 20 values of each categorical event field, such as language, country, sentiment and every taxonomy level) and numeric (count, missing, sum, min, max and mean of lat, lng, total_coverage, total_netlocs, coverage_concentration_index and materiality_score).

metadata.events_by_yearobject[]

Events per year: {year, count}, every year of the archive.

metadata.facetsobject

view=full only. Top values of each categorical field: {field: [{value, count}]}.

metadata.numericobject

view=full only. Summary statistics of each numeric field.

filterobject

Ready-made World Search filter for the ticker.

referenceobject

Reference data for the issuer: its Atlas entity, name, identifiers, listing and country; with view=full also its website, every identifier and its classification. Each part is present only when it is known.

reference.entityobject

The issuer's Atlas entity, {type, name}: the entity the Atlas API and the entity endpoints use. Absent when the ticker is not mapped to an Atlas entity.

reference.entity.typestring

NER type of the issuer's entity: ORG.

reference.entity.namestring

Canonical Atlas name of the issuer, such as Nvidia.

reference.company_namestring

Issuer name.

reference.websitesobject

view=full only. Issuer websites: website.

reference.websites.websitestring

view=full only. Main website of the issuer.

reference.identifiersobject

Identifiers of the issuer and security: isin, figi, lei and wiki_qid; view=full adds the others known.

reference.identifiers.isinstring

ISIN of the security.

reference.identifiers.leistring

LEI of the issuer.

reference.identifiers.figistring

FIGI of the security.

reference.identifiers.wiki_qidstring

Wikidata identifier of the issuer.

reference.identifiers.companyv5_idstring

view=full only. NOSIBLE company identifier of the issuer.

reference.marketobject

Listing: exchange and mic.

reference.market.exchangestring

Exchange of the listing.

reference.market.micstring

ISO 10383 market identifier code of the exchange.

reference.geographyobject

Issuer country: country_iso.

reference.geography.country_isostring

ISO 3166-1 alpha-2 country of the issuer.

reference.classificationobject

view=full only. GICS classification of the issuer: sector and industry.

reference.classification.sectorstring

view=full only. GICS sector.

reference.classification.industrystring

view=full only. GICS industry.

as_ofobject

index_build and archive_cutoff: the index that answered.

took_msinteger

Server time in milliseconds.

Responses and errors

HTTP

200Request succeeded. The response body is shown in the panel on the right.

400invalid_json — The request body is not JSON. Every error body, 401 included, is {error, message, status}.

401api_key_required — No API key was sent. Send it as Authorization: Bearer <key> or the api-key header.

401invalid_api_key — The API key is invalid or has been revoked.

403access_denied — The requested archive date is outside the caller's World tier.

422validation_error — The request is well formed but the API cannot decode or validate it: an unknown body field or query parameter, a missing required parameter, a value of the wrong type, an empty and, or or not, a date that is not a calendar date (in the path, the query or the body), an unknown enum value or a reversed range. The message names the parameter and what is wrong.

404not_found — The requested date, entity, ticker, or event does not exist in the accessible index.

410cursor_expired — The cursor was minted against a replaced index build. Restart pagination from the first page.

429rate_limited — The request exceeded the endpoint or account rate limit. Respect Retry-After when supplied.

501backend_not_configured — The World backend is not configured for this deployment.

503api_key_auth_unavailable — API key authentication is temporarily unavailable; retry shortly.

503api_key_metering_unavailable — API key usage metering is temporarily unavailable, so the request was not served; wait for the Retry-After header (30 seconds) and retry.

502backend_error — The World backend could not be reached or did not return a valid response; retry shortly.

504backend_timeout — The World backend did not answer within 300 seconds; narrow the request (for example with a date window) or retry.

404unknown_ticker — The requested symbol or identifier does not resolve to an indexed security.