# 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:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Clean Company API endpints</td><td><a href="#clean-company-api-endpoints">#clean-company-api-endpoints</a></td></tr><tr><td>Request types</td><td><a href="#request-types">#request-types</a></td></tr><tr><td>Rate limits</td><td><a href="#rate-limits">#rate-limits</a></td></tr><tr><td>Credits</td><td><a href="#credits">#credits</a></td></tr></tbody></table>

## Clean Company API endpoints

{% hint style="info" %}
Our API is a data retrieval tool. The endpoints do not support analytic features.
{% endhint %}

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/{profile\_url/shorthand\_name}* | Use profile URLs or  shorthand names from the URLs\*                                 |
| GET          | */v2/company\_clean/enrich?website={URL}*                   | Collect data using website URLs and enrichment endpoint                              |

\*📌 Full profile URL example: [www.professional-network.com/company/\*\*example-company\*\*.\\](http://www.professional-network.com/company/**example-company**.\\)
Shorthand name example: example-company.

### 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

{% hint style="warning" %}
All Clean Company API requests must be made over HTTPS. Requests made over HTTP will fail or be redirected to HTTPS.
{% endhint %}

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/{profile\_url/shorthand\_name}* |
| GET          | */v2/company\_clean/enrich?website={URL}*                   |

## Rate limits

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

{% columns %}
{% column %}
Search endpoints

Enrichment endpoints

Collection endpoints
{% endcolumn %}

{% column %}
18 requests per second

18 requests per second

54 requests per second
{% endcolumn %}
{% endcolumns %}

## 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/{profile\_url/shorthand\_name}*
* */v2/company\_clean/enrich?website={URL}*

***

Read more about credits in the following topic:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>General information about credits</td><td><a href="../api-introduction/credits">credits</a></td></tr></tbody></table>
