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.

Base Company API endpoints

Request types

Rate limits

Credits

Base Company API endpoints

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

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/{shorthand_name}	Collect company data using shorthand names*

*📌 Full profile URL example: 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}

You can try out the Base Company API playground on Coresignal's Self-service

Try Self-service

Request types

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

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/{shorthand_name}

Rate limits

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

Search endpoints

Collection endpoints

Bulk Collect search and collection endpoints

18 requests per second

54 requests per second

27 requests per second

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/{shorthand_name}

Remember that making one Bulk Collect request will consume more credits as you get bigger data batches.

---

Read more about credits in the following topic:

General information about credits