Company API
This page provides detailed information on how to retrieve company information through our 2 main API's the search: /api/company/search and export: /api/company/export endpoints. These endpoints allow you to retrieve, search, and export information about companies, with a variety of filtering options such as country, city, industry etc.
Company Search
Endpoint: /api/company/search
The /api/company/search endpoint allows users to search for companies based on various criteria. This endpoint returns a standard set of fields, including the company name and address.
Returned Fields
- ID: A unique identifier of the company, can be used to retrieve a full record.
- Company Name: The main name of the company.
- Country Name: The country of the company.
Note: it's possible to receive more fields on search, this can be requested via support.
Important Notes
- Purpose: This endpoint is primarily used to retrieve basic information such as the company name and address based on a search query. For instance in an autocomplete search.
- Filtering branches: In most cases, you'll want to add
statusCode=0,1to your query. This filters for single locations (0) and headquarters (1) only. Large companies often have many branches/subsidiaries in the database, which are typically not relevant for most use cases like lead generation or company lookup.
Example Request
curl -G https://app.companydata.com/api/company/search \
-H "x-api-key: {ApiKey}" \
-d "search=Example Company"
Additional Examples
1. Search for companies named Bolddata
curl -G https://app.companydata.com/api/company/search?page=1&pageSize=25&search=BoldData \
-H "x-api-key: {ApiKey}"
2. Search for companies named Bolddata in The NETHERLANDS
curl -G https://app.companydata.com/api/company/search?page=1&pageSize=25&search=BoldData&countryCode=NL \
-H "x-api-key: {ApiKey}"
Company Export
Endpoint: /api/company/export
The /api/company/export endpoint allows users to request a specific set of fields related to company data. The fields returned by this endpoint depend on the type of package purchased by the client.
Returned Fields
- The set of fields returned is determined by the client's subscription package. This could include detailed company information such as financial data, employee count, or contact information.
Important Notes
- Package-Dependent Fields: The fields returned by this endpoint are customized based on the client's purchased package. For more information contact support.
- Use Case: This endpoint is used for getting a full company profile, often used in CRM's or for purposing of contacting or researching a company.
Example Request
Export the first 25 companies from Rotterdam, the Netherlands with the Sic Code 3221, for glassware.
curl -G https://app.companydata.com/api/company/export?page=1&pageSize=25&sic4Digits=3221&countryCode=NL&cityName=Rotterdam? \
-H "x-api-key: {ApiKey}" \
-d "export=true"
Query Parameters
Below is a list of query parameters that can be used to filter the results returned by this endpoint. Export and search support the same parameters.
| Parameter | Description | Type | Options | Example |
|---|---|---|---|---|
ID | Company ID | String | Company ID | ID=01111 |
search | Search for company name | String | Company Name | search=Bolddata |
sic4Digits | 4-digit SIC Code. | String | A valid 4 number SIC Code | sic4Digits=0111,0115 |
importExportCode | Import/Export Code. | Enum | A: Import/Export/Agent, B: Imports & Exports, C: Imports, D: Imports & Agents, E: Exports & Agents, F: Agent (no inventory), G: Not available, H: Exports | importExportCode=B,C |
legalStatus | Legal Status of the company. | Enum | 0: Not available, 1: Proprietorship, 2: Partnership, 3: Corporation, 7: Partnership, 8: Joint venture, 9: Master limited partnership, etc. | legalStatus=1,2 |
statusCode | Status Code representing the company's location type. | Enum | 0: Single Location, 1: Headquarter/Parent, 2: Branch | statusCode=0,2 |
subsidiaryCode | Indicates if the company is a subsidiary. | Enum | 0: Not a subsidiary, 3: Is a subsidiary | subsidiaryCode=3,0 |
countryCode | Country Code where the company is located. | String | See countries page for code format | countryCode=AL,BY,NL |
provinceName | State/Province Name where the company is located. | AutoComplete | N/A | provinceName=NOORD-HOLLAND |
cityName | City Name where the company is located. | AutoComplete | N/A | cityName=AMSTERDAM |
employeesHere | Number of employees at the company's location. | Integer | Example: 10 | employeesHere[min]=2&employeesHere[max]=10 |
employeesTotal | Total number of employees in the company. | Integer | Example: 100 | employeesTotal[min]=2&employeesTotal[max]=10 |
annualSales | Annual sales in U.S. dollars. | Integer | Example: 100000 | annualSales[min]=10000&annualSales[max]=500000 |
foundingYears | Range of years the company was founded. | Integer | Example: 2022 | foundingYears[min]=2000&foundingYears[max]=2010 |
phoneNumber | Search by full Company's Phone number, internationally formatted with + sign, 00 or local not supported | String | Company Phone Number | phoneNumber=+31621700000 |
email | Search by email or email patterns such as domain or names | String | Company Email | search=bolddata.nl search=info@bolddata.nl |
worldwideHeadquarterID | Filter by Worldwide Headquarter ID | String | Worldwide Headquarter ID | worldwideHeadquarterID=1234 |
nationalId | Search by National Company Registration Number, recommended to add countryCode | String | National Company Registration Number | nationalId=123456 |
hasEmail | Indicates if an email address is available for the company. | Boolean | true, false | hasEmail=true |
hasMarketability | Indicates if the company is marked as marketable. | Boolean | true, false | hasMarketability=true |
hasPhone | Indicates if a telephone number is available for the company. | Boolean | true, false | hasPhone=true |
hasFax | Indicates if a fax number is available for the company. | Boolean | true, false | hasFax=true |
hasContactPerson | Indicates if a contact person is available for the company. | Boolean | true, false | hasContactPerson=true |
hasWebsite | Indicates if a website is available for the company. | Boolean | true, false | hasWebsite=true |
hasNationalID | Indicates if a national ID is available for the company. | Boolean | true, false | hasNationalID=true |
hasBusinessName | Indicates if a business name is available for the company | Boolean | true, false | hasBusinessName=true |
hasStreetAddress | Indicates if a street address is available for the company. | Boolean | true, false | hasStreetAddress=true |
hasPostalCode | Indicates if a postal code is available for the company. | Boolean | true, false | hasPostalCode=true |
hasCEOName | Indicates if a CEO name is available in the database for the company record. | Boolean | true, false | hasCEOName=true |