# Multi-source Company API

## Overview

This section covers basic information on the Multi-source 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>Multi-source Company API endpoints</td><td><a href="#multi-source-company-api-endpoints">#multi-source-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>

## Multi-source Company API endpoints

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

Multi-source Company API features **two search** and **three collect** endpoints for searching and collecting relevant Multi-source Company data.

| Request type | Endpoint                                                            | Function                                                                  |
| ------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| POST         | */v2/company\_multi\_source/search/es\_dsl*                         | Search for relevant company data using Elasticsearch DSL schema           |
| POST         | */v2/company\_multi\_source/search/es\_dsl/preview*                 | Retrieves a small set of partial data using Elasticsearch queries         |
| GET          | */v2/company\_multi\_source/collect/{company\_id}*                  | Collect Multi-source company data using IDs                               |
| GET          | */v2/company\_multi\_source/collect/{profile\_url/shorthand\_name}* | Collect Multi-source Company data using profile URLs or shorthand names\* |
| GET          | */v2/company\_multi\_source/enrich?website={URL}*                   | Collect Multi-source company data using website URLs                      |

\*📌 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 Multi-source Company API's functionality, featuring **two POST** and **two GET** endpoints. Bulk Collect allows you to search and collect company data in bulk using company IDs and Elasticsearch DSL queries.

| Request type | Endpoint                                                    |
| ------------ | ----------------------------------------------------------- |
| POST         | */v2/data\_requests/company\_multi\_source/ids*             |
| POST         | */v2/data\_requests/company\_multi\_source/es\_dsl*         |
| GET          | */v2/data\_requests/{data\_request\_id}/files*              |
| GET          | */v2/data\_requests/{data\_request\_id}/files/{file\_name}* |

## Request types

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

Multi-source Company API supports two types of requests:

* **Search** endpoints support POST requests only.
* **Collect** endpoints support the GET requests only.

| Request type | Endpoint                                                            |
| ------------ | ------------------------------------------------------------------- |
| POST         | */v2/company\_multi\_source/search/es\_dsl*                         |
| POST         | */v2/company\_multi\_source/search/es\_dsl/preview*                 |
| GET          | */v2/company\_multi\_source/collect/{company\_id}*                  |
| GET          | */v2/company\_multi\_source/collect/{profile\_url/shorthand\_name}* |
| GET          | */v2/company\_multi\_source/enrich?website={URL}*                   |

## Rate limits

Multi-source Company API endpoints restrict the number of requests allowed per second.

{% columns %}
{% column width="50%" %}
Search endpoints

Enrichment endpoints

Bulk Collect search and collection endpoints

Collection endpoints
{% endcolumn %}

{% column %}
18 requests per second

18 requests per second

27 requests per second

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

## Credits

**Two** search credits are deducted for **one successful (200) request** in the search endpoint:

* */v2/company\_multi\_source/search/es\_dsl*
* */v2/company\_multi\_source/search/es\_dsl/preview*

**Two** collection credits are deducted for **one successful (200) request** in the collection endpoints:

* */v2/company\_multi\_source/collect/{company\_id}*
* */v2/company\_multi\_source/collect/{profile\_url/shorthand\_name}*
* */v2/company\_multi\_source/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>
