Skip to main content
POST
Find by details

Authorizations

X-API-KEY
string
header
required

Body

application/json

Request body for finding companies. Each field is optional. However, you must provide at least one field to perform a valid search.

query
string

It accepts a partial or complete company name, webpage, ticker, ISIN, SEDOL, or CUSIP. Examples: 'Apple', 'AAPL', 'https://www.apple.com/', 'CA03785Y1007'

Example:

"Apple"

types
enum<string>[]

The company type can be PUBLIC or PRIVATE

Available options:
PUBLIC,
PRIVATE
Example:
countries
string[]

It accepts country codes using the ISO 3166-1 A-2, for instance "US" for the United States

Pattern: ^[A-Z]{2}$
Example:
sectors
string[]

It accepts a list of sectors that can be retrieved with the endpoint "/knowledge-graph/companies/sectors"

Example:

Response

200 - application/json

Successful response with company data

Response containing company results and metadata

results
object[]
required

Array of company results

metadata
object
required
usage
object

Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request.