Search Preview
Data type:
Query type:
URLs:
Base Company
Coresignal's custom filters and Elasticsearch DSL
https://api.coresignal.com/cdapi/v2/company_base/search/filter/preview https://api.coresignal.com/cdapi/v2/company_base/search/es_dsl/preview
Overview
Retrieve a limited set of fields from top-matching records in real time, and search suggestion features. Here, Base Company API search /v2/company_base/search/filter/preview and /v2/company_base/search/es_dsl/preview endpoints' usage is reviewed.
Request queries
See the request examples of preview endpoints. Search Preview endpoints accept the same query structure as their corresponding Search endpoints.
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/company_base/search/filter/preview' \
-H 'accept: application/json' \
-H 'apikey: {API Key}' \
-H 'Content-Type: application/json' \
-d '{
"industry": "Data",
"location": "USA",
"founded_year_gte": 2022
}'curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/company_base/search/es_dsl/preview' \
-H 'accept: application/json' \
-H 'apikey: {API Key}' \
-H 'Content-Type: application/json' \
-d '{
"query":{
"bool":{
"must":[
{
"query_string":{
"query":"2024",
"default_field":"founded",
"default_operator":"and"
}
}
]
}
}
}'Response structure
Here is an overview of the fields that are retrieved using the Base Company API search preview endpoints.
id
Identification number
Integer
name
Company name
String
canonical_url
The most recent profile URL
String
website
Company's website
String
size
Company size category (determined by the number of employees)
String
industry
Company's industry
String
headquarters_country_parsed
Country the company is based in (as parsed by our in-house country parser)
String
_score
Elasticsearch score
Float
Refer to the data example here:
{
"id": 123456789,
"name": "Example Company",
"canonical_url": "https://www.professional-network.com/company/example-company",
"website": "www.example-company.com",
"size": "2-10 employees",
"industry": "IT System Data Services",
"headquarters_country_parsed": "Germany",
"_score": 18.12345
}, {
"id": 10203040,
"name": "Example Tech",
"canonical_url": "https://www.professional-network.com/company/example-tech",
"website": "http://www.example-tech.org",
"size": "2-10 employees",
"industry": "Business Consulting and Services",
"headquarters_country_parsed": "United States",
"_score": 10.0
},Pagination
Example of the request using pagination query parameter page.
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/company_base/search/filter/preview?page=3' \
-H 'accept: application/json' \
-H 'apikey: {API Key}' \
-H 'Content-Type: application/json' \
-d '{
"industry": "Data",
"location": "USA",
"founded_year_gte": 2022
}'curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/company_base/search/es_dsl/preview?page=4' \
-H 'accept: application/json' \
-H 'apikey: {API Key}' \
-H 'Content-Type: application/json' \
-d '{
"query":{
"bool":{
"must":[
{
"query_string":{
"query":"2024",
"default_field":"founded",
"default_operator":"and"
}
}
]
}
}
}'Last updated
Was this helpful?