Get company profile
Who a company, security or fund is: names, description, sector, size, addresses and identifiers.
How it works
-
Look up an identifier. Include the exchange if a ticker is ambiguous. For example,
TSCO:LNidentifies Tesco in London. -
A company name can match as a fallback. A unique name match returns
match: "name_match"and the selected ISIN inmatched_identifier. -
nameis in Latin script;legal_nameis the name as registered. For Hellenic Telecommunications,nameis a Latin form andlegal_nameis its Greek registered name. Only when no source gives a Latin form doesnamekeep the original script. -
Two countries, never mixed.
domicile_countryis where the company is legally registered andheadquarters_countryis where it's run from. They differ for companies incorporated offshore. -
primary_listingidentifies the main listing when the evidence supports one. It's the same object as a venue in Get securities and listings, plus its security'sisin, so code that reads one reads both. Funds with several trading lines can have a null primary. Every other venue is in Get securities and listings. - If we can't tell which company you mean, you get a 404 saying so. That covers identifiers that match nothing and ones that match several. The message says what to try, and the request is free.
Request
GET /api/v1/profile with your API key. AI assistants call it as the get_profile tool, with the same parameters.
Parameters
qstringrequired
Ticker with its exchange code or MIC (AAPL:US, AAPL:XNAS, TSCO:XLON), ISIN, CUSIP, SEDOL, WKN, FIGI, LEI, CIK or company registration number. Any ticker and mic a listing returns work as ticker:mic. A company name can match as a fallback.
More parameters
include_sourcesboolean
Include available source documents and supporting evidence. Omit for data only.
Default: false
Response
JSON with these fields. A field the source doesn't report is null or left out.
queryThe identifier or company name asked for
identifier_typeType of the requested identifier, null for a name match or ambiguous lookup
matched_identifierobject
Show child attributes
typeIdentifier scheme selected by the name fallback
valueIdentifier selected by the name fallback
profileobjectrequired
Show child attributes
typeIdentity scope: legal_entity, fund, share_class, security or listing
namePreferred display name, in Latin script whenever any source gives one. A company registered under a name in another script, such as Greek, gets a Latin form here; its registered name is legal_name
short_nameShort display name, in Latin script when any source gives one
legal_nameReported legal name of the subject or identified issuer exactly as registered, which can be in its own language and script; not inferred from the display name
cikTen-digit SEC CIK of the subject or identified issuer
phoneReported company contact telephone number
legal_formReported legal form of the entity
descriptionBusiness or investment-product description; a fund’s stated investment objective is labeled explicitly
websiteIssuer, fund or fund-brand website
security_typeInstrument or fund type: common_stock, preferred_stock, depositary_receipt, reit, tracking_stock, stapled_security, unit, right, warrant, etf, etn, etc, etp, open_end_fund, closed_end_fund, private_equity_fund, investment_fund, derivative, other. The list can grow, so treat a value you don't recognise as other
domicile_countryCountry where the entity, issuer or fund is legally registered, as an ISO 3166-1 alpha-2 code. Not its headquarters.
headquarters_countryCountry the company is run from, as an ISO 3166-1 alpha-2 code. Can differ from domicile_country, for example for companies incorporated offshore.
sectorBusiness sector
industryBusiness activity, such as Computer hardware or Food retail
number_of_employeesReported workforce count from the last three years
employees_as_ofDate or period of the workforce count
employees_basisWhat the count measures: headcount, full_time, full_time_equivalent or full_time_and_full_time_equivalent
employees_estimatedWhether the source published the count as an approximation
employee_rangeEmployee range, such as 200000-499999
founded_onFounding date of the business: YYYY, YYYY-MM or YYYY-MM-DD
incorporated_onIncorporation date of the current legal entity
first_traded_onFirst trading date for this ISIN at an admitting venue; may reflect a new ISIN or venue start, not the company's IPO
public_floatobject
Show child attributes
valueReported market value of equity held by non-affiliates as a decimal string; not a share count or total market cap
currencyISO 4217 currency code of the reported public-float value
as_ofMeasurement date of the reported public-float value
market_capobject
Show child attributes
valueReported market capitalisation as a decimal string, dated by as_of
currencyISO 4217 currency code
as_ofSnapshot observation date, not a live quote timestamp
shares_outstandingobject
Show child attributes
valueReported shares outstanding for the issuer or stated share class. The count may cover a broader scope than the security identifier. Null when disclosures conflict.
as_ofMeasurement date, or observation date for an exchange snapshot
filing_datePublication date of the supporting filing, when available
reporting_currencyCurrency shared by the latest available annual financial figures; null when mixed or unavailable
reporting_currency_as_ofPeriod end of the annual facts used for reporting_currency
fiscal_year_endobject
Show child attributes
monthMonth the fiscal year ends
dayDay the fiscal year ends
headquartersobject
Show child attributes
line1First address line
line2Further address lines
cityCity
regionRegion or state code
postal_codePostal code
countryISO 3166-1 alpha-2 country code
registered_addressobject
Show child attributes
line1First address line
line2Further address lines
cityCity
regionRegion or state code
postal_codePostal code
countryISO 3166-1 alpha-2 country code
classificationsarray of objects
Show child attributes
schemeScheme, such as SEC SIC, NACE Rev. 2 or ISO 10962 CFI
codeCode in the scheme
nameName of the code
entity_statusLegal entity registration status: active or inactive. Does not establish whether a security is trading
sec_filings_urlSEC filing page for the identified company or issuer
primary_listingobject
Show child attributes
isinISIN of the security this listing trades
tickerReported ticker for this trading line, which may use the source's symbol format
exchangeExchange name
micMost specific ISO 10383 MIC of the trading line: a segment MIC (XNGS) or, off-segment, the operating MIC
operating_micISO 10383 MIC of the exchange that runs the segment (XNAS for XNGS); equal to mic on the operating market itself
countryISO 3166-1 alpha-2 country code of the exchange
currencyISO 4217 currency of this listing, never a minor unit: a London line quoted in pence is GBP. Null when unavailable or conflicting
figiFIGI of this trading line (venue level)
composite_figiCountry-level composite FIGI of this listing
listed_onReported listing date at this exchange, not necessarily the company's IPO date
is_primaryWhether it's the primary listing; null when the primary is unknown
relationshipsarray of objects
Show child attributes
relationshipissued_by identifies the legal issuer or umbrella; share_class_of identifies the specific fund; managed_by and umbrella_managed_by distinguish direct and umbrella management; sibling-security inventories are omitted
typeIdentity scope of the related subject
nameName of the related company or fund
websiteManager website, when supplied for a managed_by or umbrella_managed_by relationship
matchIdentifier lookup outcome. A found match can still have an empty page.
Errors
| Status | Meaning |
|---|---|
| 400 | Missing, unknown or invalid parameter, or an identifier that can't be looked up |
| 401 | Missing, unknown or revoked API key |
| 402 | No active plan or trial, or the included request allowance is used |
| 403 | API access of the account is suspended |
| 404 | The identifier matches nothing or is ambiguous. The match field identifies the outcome |
| 429 | Over the plan's rate limit; Retry-After says when to retry |
| 500 | Internal error; the same request is unlikely to succeed on retry |
| 503 | The data couldn't be loaded right now; Retry-After says when to retry, when known |
Errors are JSON with an error message saying what to fix. Errors are free. See Errors and limits.