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.
Example Request
curl -G https://app.bolddata.nl/api/company/search \
-H "x-api-key: {ApiKey}" \
-d "search=Example Company"
Additional Examples
1. Search for companies named Bolddata
curl -G https://app.bolddata.nl/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.bolddata.nl/api/company/search?page=1&pageSize=25&search=BoldData&countryName=NETHERLANDS \
-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.bolddata.nl/api/company/export?page=1&pageSize=25&sic4Digits=3221&countryName=NETHERLANDS&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 | Integer | Company ID | ID=1234 |
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 |
countryName | Country Name where the company is located. | String | See countries page for name format | countryName=ALBANIA,BELARUS,NETHERLANDS |
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 countryName | 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 |
Returned Fields Descriptions
Below are the descriptions for the fields that may be returned in the API response.
Note: not all fields are returned, this depends on the package you've purchased, talk to support if you to receive more fields.
Field Name BoldData | Description |
---|---|
ID | Unique identification number which is important to keep so that you can identify companies in your database |
Company Name | The main name of the company |
Trade Name | Another name the company might go by |
Address Status | For European records, if we only have the registered address, it will be listed as the physical address |
Address 1 | Where the company is located |
Address 2 | Extra details about the location |
City | The city where the company is situated. |
State/Province | The region where the company operates |
Country | The country where the company is located. |
Postal Code | The zip or postal code for the physical location. |
A code for the continent where the company is located. | |
Continent Code | 1 = Africa 2 = Australia/Asia 3 = Europe |
4 = Middle East 5 = South & Central America | |
6 = North America | |
Company Registration Number | A official and unique company ID used in some countries for registration and taxes. |
Company Registration Type Code | A code that identifies the type of national ID number system used in each country. Examples include CRO numbers in the U.K. and the Dutch KvK numbers. |
Country Phone Access Code | The dialing code to reach the country from outside. |
Phone Number | The company phone number (U.S. numbers have area codes, no punctuation). |
Cable Telex | The cable or telex number for the company. |
Fax Number | The fax number for the company. |
CEO Name | The contact with the highest ranking authority of the company at this location |
CEO Title | The title of the highest ranking authority, possibly abbreviated |
Business Category | A description in English of what the company does |
Business Category Code 1 | The main activity code based on the 1987 U.S. classification system |
**Business Category Code 1 - Description ** | Description of the main activity code based on the 1987 U.S. classification system |
Founding Year | A four-digit field representing the year the current ownership took control or the year the company was established if no change in control occurred. Not available for branch records. |
Yearly Revenue Local Currency | Sales for the company in the local currency. See currency code to determine the currency used. |
Yearly Revenue Indicator | Code describing the sales volume ('0' = actual, '1' = low end of range, '2' = estimated or not available if sales value is zero; Empty = not available). |
Yearly Revenue in U.S. Dollars | Sales for the company in U.S. dollars. Currency exchange rate is updated once each year. |
Currency Code | Code indicating the currency in which annual sales volume, net worth, and profit-loss are expressed. |
Employees On Site | The number of employees at this location (available for U.S. and Canadian records). |
Employees On Site Indicator | Indicates the availability of information on the number of employees at this location ('0' = actual, '1' = low end of range, '2' = estimated or not available if employees here value is zero; Empty = not available). |
Employees Total | The total number of employees in the company |
Employees Total Indicator | Indicates the availability of information on the total number of employees in the company ('0' = actual, '1' = low end of range, '2' = estimated or not available if employees here value is zero; Empty = not available). |
Include Principles Indicator | Indicates whether principles are included in the employee total figure ('Y' = included), primarily available on non-U.S. records. |
This is information which suggest that the company either imports materials for re-manufacture or sale, exports products to other countries or both. | |
Possible value include: | |
A Import/Export/Agent | |
B Imports & Exports | |
C Imports | |
Import/Export Code | D Imports & Agents |
E Exports & Agents | |
F Agent - keeps no inventory and does not take title goods. | |
G Not available or none | |
H Exports | |
Empty Not available | |
This code represents the legal Type of this company. | |
Possible codes are: | |
Empty or 0 = not available | |
1 or 13 = proprietorship type | |
2 or 7 = partnership | |
3 = corporation | |
Business Legal Type | 8 = joint venture |
9 = master limited partnership | |
10 = general partnership | |
11 = limited partnership | |
12 = partnership of unknown | |
14 = limited liability | |
15 = friendly society | |
There may be other code values in this field that are currently not defined. | |
Control Indicator | Field not currently in use. |
Indicates whether the company is a single location, headquarter/parent, or branch. | |
0 = Single Location (no other entities report to it) | |
Location Type | 1 = Headquarter/Parent (branches and/or subsidiaries report to it) |
2 = Branch (secondary location to a headquarter) | |
Note: Empty when not available. | |
This code indicates if a company is a subsidiary or not. | |
The values are as follows: | |
Subsidiary Code | 0 Not a subsidiary |
3 Is a subsidiary | |
This field is populated on linked records only. Otherwise Empty. | |
Local Headquarter ID Number | ID number of the Local Headquarter that represents the immediate entity above the site. Empty if not linked. |
Local Headquarter Company Name | The main name of the Local Headquarter. Empty if not linked. |
Local Headquarter Street Address | Physical street address of the Local Headquarter. Empty if not linked. |
Local Headquarter City | Name of the city where the Local Headquarter is located. Empty if not linked. |
Local Headquarter State/Province | The state/province name in which the Local Headquarter is located. Empty if not linked. |
Local Headquarter Country Name | Name of the country in English where the Local Headquarter is located. Empty if not linked. |
National Headquarter ID Number | ID Number for the National Headquarter represents the highest member of the company group within the same country as the site. A case may be its own National Headquarter. |
National Headquarter Company Name | The primary name of the National Headquarter Company. Empty if not linked. |
National Headquarter Street Address | Physical street address of the National Headquarter company. Empty if not linked. |
National Headquarter City Name | Name of the city where the National Headquarter is located. Empty if not linked. |
National Headquarter State/Province Name | Name of the state or province in which the National Headquarter is located. Empty if not linked. |
Global Headquarter ID Number | The ID number of the upper most parent of a corporate group. Global Headquarter records carry their own case ID number in this field so that a common sort and/or match area is available for all group members. Empty if not linked. |
Global Headquarter Company Name | Name of the Global Headquarter. Empty if not linked. |
Global Headquarter Street Address | Physical address of the Global Headquarter. Empty if not linked. |
Global Headquarter City Name | Name of the city where the Global Headquarter is located. Empty if not linked. |
Global Headquarter State/Province | Name of the state or province in which the Global Headquarter is located. Empty if not linked. |
Global Headquarter Country Name | Name of the country where the Global Headquarter is located. Empty if not linked. |
Number of Companies in Group | The number of companies in the global group including the Global Headquarter and all subsidiaries and branches of the entire organizational group globally. Every company in the organizational chart carries the same count. Empty if not linked. |
Website | Company URL of the company |
Email addresses of the company |