POST Requests: Base Company API

Data type:

URLs:

Base Company

https://api.coresignal.com/cdapi/v2/data_requests/company_base/filter https://api.coresignal.com/cdapi/v2/data_requests/company_base/es_dsl https://api.coresignal.com/cdapi/v2/data_requests/company_base/id_file

---

Overview

Bulk Collect features three POST endpoints, making collecting company data records in bulk easier.

Before you proceed with your Bulk Collect requests, test them in the Base Company API first to avoid any unexpected costs.

This step is important because these requests can potentially be quite expensive.

By doing this, you can see how many records your query will return and understand the credits the Bulk Collect query will require.

Find step-by-step guides of making Bulk Collect POST requests in the following topic:

Bulk Collect POST requests guides

Search filter POST requests

Use the endpoint /v2/data_requests/company_base/filter to request company data in bulk using search filters.

Base Company API Search filters

Endpoint usage example

Example request

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/company_base/filter' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
   "data_format": "json",
   "webhook_url": "{optional_webhook_url}",
   "limit": {optional_integer}
   "filters": {
      "industry": "Information technology",
      "created_at_gte": "2018-01-01 00:00:01",
      "last_updated_gte": "2022-05-26 00:00:01"
   }
}'

Retrieve the request_id from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

---

Elasticsearch DSL requests

Use the endpoint /v2/data_requests/company_base/es_dsl to request company data in bulk using our Elasticsearch DSL schema.

Base Company API Elasticsearch DSL schema

Endpoint usage example

Example request

curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/data_requests/company_base/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
   "data_format": "json",
   "webhook_url": "{optional_webhook_url}",
   "limit": {optional_integer}
   "es_dsl_query": {
      "query": {
         "bool": {
            "must": [
               {
                  "query_string": {
                     "query": "(3D printing) OR (3D printing service) OR (Lead generation)",
                     "default_field": "description",
                     "default_operator": "and"
                  }
               }
            ]
         }
      }
   }
}'

Retrieve the request_id from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

---

ID File requests

Use the endpoint /v2/data_requests/company_base/id_file to submit a list of IDs in a .csv or .txt file to request company data in bulk. The following topic explains how to make ID File request:

ID File request guide

Endpoint usage example

cURL request

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/company_base/id_file' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'ids_file=@id_list_example.csv;type=text/csv' \
  -F 'data_format=json' \
  -F 'webhook_url={optional_webhook_url}'

Retrieve the request_id from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

---

Following steps

Make GET requests to download the data