Company Data

Clean Company API

12min

This section covers basic information on the Clean Company API. 
Clean Company endpoints
Our API is a data retrieval tool. The endpoints do not support analytic features. 
Clean Company API features one search endpoint and two collect endpoints to retrieve clean company data. 
Use the endpoints with any API-compatible application.
Request type
Endpoint
POST
/v1/professional_network/clean_company/search/es_dsl 
GET
/v1/professional_network/clean_company/collect/{company_id}
GET
/v1/professional_network/clean_company/collect/{shorthand_name}
Request types
All Clean Company API requests must be made over HTTPS.  Requests made over HTTP will fail.
Clean data API supports two types of requests:
Search endpoints support POST requests only.
Collect endpoints support the GET requests only.
Endpoint /v1/professional_network/clean_company/search/es_dsl information.
Make a POST request to collect a set of IDs using:
an Elasticsearch DSL schema that maps directly to our output data. 
 The IDs can then be used in GET requests to receive Clean Company data. 
Information for /v1/professional_network/clean_company/collect/{company_id} and /v1/professional_network/clean_company/collect/{shorthand_name} endpoints.
Make a query using the GET method to: 
Convert the collected IDs to clean company data
Convert the shorthand names from the company profile URLs to clean company data. 
Rate limits
The Clean Company API endpoints restrict the number of requests allowed per second for each client's API token.
Clean Company API search endpoints
Clean Company API collect endpoints
Allow 27 requests per second.
Allow 54 requests per second.
Authorization
To start using our API, you need a (JWT) token. Your account manager or sales will generate the token for you upon your request for the API plan. 
Use the token to authorize and begin your queries. If you are unsure about the process, check out the tutorials on authorization located at the bottom of this section for guidance.
﻿
All requests to the Clean Company API must contain an Authorization header that consists of a Bearer authentication string and the JSON Web Token (JWT).
Authorization header
Authorization header
-H “Authorization: Bearer {JWT}”
-H “Authorization: Bearer {JWT}”
﻿
Python
Ruby
Node.js
PHP
import requests

api_endpoint = "API_ENDPOINT"
jwt_token = "JWT_TOKEN"

headers = {
    "Authorization": f"Bearer {jwt_token}"
}

response = requests.get(api_endpoint, headers=headers)

# Print the response content or handle it as needed
print(response.text)
import requests

api_endpoint = "API_ENDPOINT"
jwt_token = "JWT_TOKEN"

headers = {
    "Authorization": f"Bearer {jwt_token}"
}

response = requests.get(api_endpoint, headers=headers)

# Print the response content or handle it as needed
print(response.text)
﻿
POST
GET {ID}
curl -X GET "https://api.coresignal.com/cdapi/v1/professional_network/clean_company/collect/7"
-H  "accept: application/json" 
-H  "Authorization: Bearer {JWT}"
curl -X GET "https://api.coresignal.com/cdapi/v1/professional_network/clean_company/collect/7"
-H  "accept: application/json" 
-H  "Authorization: Bearer {JWT}"
﻿
All Clean Company API requests must be made over HTTPS.  Requests made over HTTP will fail.
Use any API-compatible tool to authorize and start querying in the API.
If you're unsure where to begin, consider trying the tools we've provided tutorials for, such as Postman (cURL requests) and Swagger UI.
Credits and tokens
The token issued for you has a set amount of search and collect credits.
One search credit is deducted for one successful (200) request in the search endpoints:
/v1/professional_network/clean_company/search/es_dsl
﻿
One collect credit is deducted for one successful (200) request in the collection endpoints:
/v1/professional_network/clean_company/collect/{company_id}
/v1/professional_network/clean_company/collect/{shorthand_name}
Discuss your credit needs with your account manager. 
Every search and collect response contains an X-Credits-Remaining header that shows the number of credits left in your account.
You can find the credit balance by clicking Header in the Postman application.
﻿
Example of remaining credits header:
JSON
x-credits-remaining: 9973
x-credits-remaining: 9973
﻿
﻿

Request type	Endpoint
POST	/v1/professional_network/clean_company/search/es_dsl
GET	/v1/professional_network/clean_company/collect/{company_id}
GET	/v1/professional_network/clean_company/collect/{shorthand_name}

Enrich

Data Dictionary: Clean Company API

Clean Company API

Clean Company endpoints

Request types

POST requests

GET requests

Rate limits

Authorization

General authorization examples

Example requests

Credits and tokens

Where can I see my credit balance?