General Introduction

Authorization

6min

Authorization key
To start using our API, you need an API Key. You can get the API Key from Coresignal's self-service platform. Moreover, your account manager or sales representative can generate the key for you upon your request for the API plan.
﻿
Authorization header
All requests must contain an API Key header. Its value is your unique API Key.
Authorization header
Authorization header
-H “apikey: {API Key}”
-H “apikey: {API Key}”
﻿
cURL authorization
Several examples of authorization in cURL are given according to the required request. Here, requests are made using Base Company API﻿ endpoints.
Elasticsearch DSL
Search filter
Collect
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/company_base/search/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
   "query":{
      "bool":{
         "must":[
            {
               "query_string":{
                  "query":"2023",
                  "default_field":"founded",
                  "default_operator":"and"
               }
            }
         ]
      }
   }
}'
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/company_base/search/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
   "query":{
      "bool":{
         "must":[
            {
               "query_string":{
                  "query":"2023",
                  "default_field":"founded",
                  "default_operator":"and"
               }
            }
         ]
      }
   }
}'
﻿
﻿General authorization templates
Templates for authentication in various programming languages and programming environment.
Python
Ruby
Node.js
PHP
import requests

api_endpoint = "API_ENDPOINT"
api_key = {API Key}

headers = {
    "apikey": api_key
}

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"
api_key = {API Key}

headers = {
    "apikey": api_key
}

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

# Print the response content or handle it as needed
print(response.text)
﻿
Use any API-compatible tool to authorize and start querying the API.
FAQ
API Key is stored in the self-service platform home page's Authentication section. 
If you've previously used a JWT token, you need to change it to an API Key.
Change your authorization request header's to API Key:
-H 'apikey: {API Key}' 
Here, insert your API Key instead of {API Key}
Make sure that you are using the correct endpoints. API Key is compatible with v2 endpoints. For example: /v2/company_base/search/es_dsl
Note: several enrichment endpoints do not have v2, but still work with API Key.
﻿
﻿

Introducing APIs

Credits

Authorization

Authorization key

Authorization header

cURL authorization

General authorization templates

FAQ

Where can I find my API Key?

How do I use API Key?

Authorization

Authorization key

Authorization header

cURL authorization

﻿General authorization templates

FAQ

Where can I find my API Key?

How do I use API Key?

General authorization templates