# Base Company API

## Overview

This section covers general details about Base Company API.\
Follow the links inside the topics to learn more about the API and its endpoints.

<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>Base Company API endpoints</td><td><a href="/pages/7XD8BNSl8AQvZi137knw#base-company-api-endpoints">/pages/7XD8BNSl8AQvZi137knw#base-company-api-endpoints</a></td></tr><tr><td>Request types</td><td><a href="/pages/7XD8BNSl8AQvZi137knw#request-types">/pages/7XD8BNSl8AQvZi137knw#request-types</a></td></tr><tr><td>Rate limits</td><td><a href="/pages/7XD8BNSl8AQvZi137knw#rate-limits">/pages/7XD8BNSl8AQvZi137knw#rate-limits</a></td></tr><tr><td>Credits</td><td><a href="/pages/7XD8BNSl8AQvZi137knw#credits">/pages/7XD8BNSl8AQvZi137knw#credits</a></td></tr></tbody></table>

## Base Company API endpoints

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

Base Company API features **four search** and **two collect** endpoints. Use the endpoints with any API-compatible application to retrieve Base Company data.

| Request type | Endpoint                                                   | Function                                                            |
| ------------ | ---------------------------------------------------------- | ------------------------------------------------------------------- |
| POST         | */v2/company\_base/search/filter*                          | Search for relevant company profiles using search filters           |
| POST         | */v2/company\_base/search/filter/preview*                  | Retrieves a small set of partial data using search filters          |
| POST         | */v2/company\_base/search/es\_dsl*                         | Search for relevant company profiles using Elasticsearch DSL schema |
| POST         | */v2/company\_base/search/es\_dsl/preview*                 | Retrieves a small set of partial data using Elasticsearch queries   |
| GET          | */v2/company\_base/collect/{company\_id}*                  | Collect company data using IDs                                      |
| GET          | */v2/company\_base/collect/{profile\_url/shorthand\_name}* | Collect company data using profile URLs or shorthand names\*        |

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

| Request type | Endpoints                                                   |
| ------------ | ----------------------------------------------------------- |
| POST         | */v2/data\_requests/company\_base/id\_file*                 |
| POST         | */v2/data\_requests/company\_base/filter*                   |
| POST         | */v2/data\_requests/company\_base/es\_dsl*                  |
| GET          | */v2/data\_requests/{data\_request\_id}/files*              |
| GET          | */v2/data\_requests/{data\_request\_id}/files/{file\_name}* |

{% hint style="success" %}
You can try out the Base Company API playground on Coresignal's Self-service

<a href="https://dashboard.coresignal.com/home" class="button primary">Try Self-service</a>
{% endhint %}

## Request types

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

Base 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\_base/search/filter*                          |
| POST         | */v2/company\_base/search/filter/preview*                  |
| POST         | */v2/company\_base/search/es\_dsl*                         |
| POST         | */v2/company\_base/search/es\_dsl/preview*                 |
| GET          | */v2/company\_base/collect/{company\_id}*                  |
| GET          | */v2/company\_base/collect/{profile\_url/shorthand\_name}* |

## Rate limits

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

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

Collection endpoints

Bulk Collect search and collection endpoints
{% endcolumn %}

{% column %}
18 requests per second

54 requests per second

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

## Credits

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

* */v2/company\_base/search/filter*
* */v2/company\_base/search/filter/preview*
* */v2/company\_base/search/es\_dsl*
* */v2/company\_base/search/es\_dsl/preview*

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

* */v2/company\_base/collect/{company\_id}*
* */v2/company\_base/collect/{profile\_url/shorthand\_name}*

{% hint style="warning" %}
Remember that making one Bulk Collect request will consume more credits as you get bigger data batches.
{% endhint %}

***

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="/pages/B1zFzH84OnIoh2EnKrvE">/pages/B1zFzH84OnIoh2EnKrvE</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.coresignal.com/company-api/base-company-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.