Clean Company API

Overview

This section covers basic information on the Clean Company API.

To learn more about the API and its endpoints, follow the links below:

Clean Company API endpints

Request types

Rate limits

Credits

Clean Company API endpoints

Our API is a data retrieval tool. The endpoints do not support analytic features.

Clean Company API features two search endpoints and three collect endpoints to retrieve clean company data. Use the endpoints with any API-compatible application.

Request type	Endpoint	Function
POST	/v2/company_clean/search/es_dsl	An Elasticsearch DSL schema that maps directly to our output data.
POST	/v2/company_clean/search/es_dsl/preview	A Preview endpoint retrieves a small set of partial data using Elasticsearch queries
GET	/v2/company_clean/collect/{company_id}	Convert the collected IDs to clean company data
GET	/v2/company_clean/collect/{shorthand_name}	Convert the shorthand names from the company profile URLs to clean company data
GET	/v2/company_clean/enrich?website={URL}	Collect data using website URLs and enrichment endpoint

Bulk Collect

Bulk Collect (Bulk API) expands upon Clean Company API's functionality, featuring four POST and two GET endpoints. Bulk Collect allows you to search and collect company data in bulk using company IDs, Elasticsearch DSL queries and shorthand names or URLs.

Request type	Endpoint
POST	/v2/data_requests/company_clean/ids
POST	/v2/data_requests/company_clean/es_dsl
POST	/v2/data_requests/company_clean/shorthand_names
POST	/v2/data_requests/company_clean/urls
GET	/v2/data_requests/{data_request_id}/files
GET	/v2/data_requests/{data_request_id}/files/{file_name}

Request types

All Clean Company API requests must be made over HTTPS. Requests made over HTTP will fail or be redirected to HTTPS.

Clean Company API supports two types of requests:

• Search endpoints support POST requests only.

• Collect endpoints support GET requests only.

Request type	Endpoint
POST	/v2/company_clean/search/es_dsl
POST	/v2/company_clean/search/es_dsl/preview
GET	/v2/company_clean/collect/{company_id}
GET	/v2/company_clean/collect/{shorthand_name}
GET	/v2/company_clean/enrich?website={URL}

Rate limits

Clean Company API endpoints restrict the number of requests allowed per second.

Search endpoints

Enrichment endpoints

Collection endpoints

18 requests per second

18 requests per second

54 requests per second

Credits

One search credit is deducted for one successful (200) request in the search endpoints:

• /v2/company_clean/search/es_dsl

• /v2/company_clean/search/es_dsl/preview

One collect credit is deducted for one successful (200) request in the collection endpoints:

• /v2/company_clean/collect/{company_id}

• /v2/company_clean/collect/{shorthand_name}

• /v2/company_clean/enrich?website={URL}

---

Read more about credits in the following topic:

General information about credits