Search companies by name
You can use this endpoint if you need more information about the company, but be careful.
Two companies can have the same name, for example, Bolt.
That's why this feature can return multiple companies.
If you have a company's domain name, it's better to use it.
We use it as a unique key in our database.
Signup to access all the features
Get your API token and start implementing the API in your product with 500 free credits.
No credit card required
The company name.
…/companies/by-name?name=microsoft
The page to fetch (default to 1).
/companies/by-name?page=1
The countries to filter the companies by. You can provide multiple countries separated by a comma. Default to all countries.
/companies/by-name?countries=us,fr,de
Possible values
If set to true, the company name must match the searched words. 'Bank of A' will not return Bank of America but 'Bank of' and 'Bank of America' will. Default to true.
/companies/by-name?exactWordsMatch=false
Comma-separated IDs of your lists containing companies to exclude from the results.
/companies/by-name?listsToExclude=3920,3925
attributes.searchFields
/companies?searchFields[]=domain&searchFields[]=name
Possible values
Return a simplified version of the companies (no credits deducted but limitation are applied on the free plan). It is useful for previewing the data before fetching the full version. Default to false.
/companies/by-name?simplified=true
Possible values
The number of companies to be returned (between 1 and 25). Default to 1.
/companies/by-name?name=amazon&size=2
An array of multiple fields combined to sort the results.
…/companies/by-name?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Make sure this parameter is stringified and encoded.
The field to sort the results.
…/companies/by-name?sortKey=meta.score
Possible values
The order to sort the results.
…/companies/by-name?sortOrder=asc
Possible values
The metas information.
import createClient from '@thecompaniesapi/sdk'
const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })
const response = await tca.searchCompaniesByName({
name: 'The Companies API',
size: 2
})
const companies = response.data.companies // Companies that match the name
const meta = response.data.meta // Meta information