Bulk Collect

Overview

Discover the Bulk Collect (Bulk API) capabilities and explore potential uses for efficiently retrieving company data in batches. Find all Bulk Collect related information in the following topic:

General information about Bulk Collect

Bulk collect endpoints

Bulk Collect is an extension of Base Company API and includes three POST and two GET endpoints.

Collect company data in bulk using an ID list, search filters, or Elasticsearch DSL schema that is already used in the Base Company API.

Request type	Endpoint
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}

Limiting the returned record count

Include the parameter "limit": int to control the number of records returned by your queries in /v2/data_requests/company_base/filter and /v2/data_requests/company_base/es_dsl endpoints.

Request example to retrieve five records

Search filters example

Search filters example

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 '{
   "webhook_url": {optional_webhook_url}",
   "limit": 5,
   "filters": {
      "industry": "Information technology",
      "created_at_gte": "2018-01-01 00:00:01",
      "last_updated_gte": "2022-05-26 00:00:01"
   }
}'

Elasticsearch DSL example

Elasticsearch DSL example

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 '{
  "webhook_url": "{optional_webhook_url}",
  "limit": 5,
   "es_dsl_query": {
      "query": {
         "bool": {
            "must": [
               {
                  "query_string": {
                     "query": "(3D printing) OR (3D printing service) OR (Lead generation)",
                     "default_field": "description",
                     "default_operator": "and"
                  }
               }
            ]
         }
      }
   }
}'

Credits

Your credits for Base Company API will also apply to Bulk Collect data collection requests.

Learn about the credits in Bulk Collect usage in the general Bulk Collect topic.

Rate limits

Bulk Collect endpoints have limited requests allowed per second. Learn about credits in Bulk Collect usage in the main Base Company API topic.

Webhooks

POST endpoints allow you to add webhooks and get notified when your data request is ready.

Keep in mind that the webhook_url parameter is optional

ID file cURL template

ID file cURL template

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 'webhook_url={optional_webhook_url}'

Search Filter template

Search Filter template

{
  "webhook_url": "{optional_webhook_url}",
  "filters": {}
}

Elasticsearch DSL template

Elasticsearch DSL template

{
  "webhook_url": "{optional_webhook_url}",
  "es_dsl_query": {}
}