Company Data
...
Base Company API
Endpoints

Elasticsearch DSL

6min
data type company query type elasticsearch domain specific language (es dsl) url /v2/company base/search/es dsl overview use the /v2/company base/search/es dsl endpoint for more sophisticated queries https //www elastic co/guide/en/elasticsearch/reference/current/query dsl fuzzy query html for example, you can use fuzzy and wildcard queries in the endpoint additionally, the endpoint allows you to operate filters that mimic our company data, enabling you to write more sophisticated queries than using the /v2/company base/search/filter endpoint elasticsearch schema https //docs coresignal com/api/company api esdsl endpoint#d5efq refer to the company api elasticsearch schema sorting options https //docs coresignal com/api/company api esdsl endpoint#dmanf information about possible sorting options limitations https //docs coresignal com/api/company api esdsl endpoint#weqq3 information about endpoint limitations elasticsearch schema response codes docid\ sp7phdapzbmyiyggsihfw see the list of possible error codes request examples https //docs coresignal com/api/company api requests esdsl test out the endpoint with suggested examples endpoint schema "mappings" { "properties" { "id" { "type" "long" }, "url" { "type" "text", "fields" { "exact" { "type" "keyword" } } }, "name" { "type" "text", "fields" { "exact" { "type" "keyword" } } }, "website" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" }, "filter" { "type" "text", } } }, "size" { "type" "keyword", "null value" "null" }, "industry" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "description" { "type" "text" }, "founded" { "type" "date", "null value" "1000", }, "headquarters country parsed" { "type" "keyword", "null value" "null" }, "headquarters new address" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "source id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "type" { "type" "text" }, "employees count" { "type" "long", "null value" 1 }, "shorthand name" { "type" "keyword" }, "canonical url" { "type" "text", "fields" { "exact" { "type" "keyword" } } }, "canonical shorthand name" { "type" "keyword" }, "deleted" { "type" "byte" }, "company crunchbase info collection" { "type" "nested", "properties" { "id" { "type" "long" }, "cb url" { "type" "text", "fields" { "exact" { "type" "keyword" } } } } }, "company specialties collection" { "type" "nested", "properties" { "id" { "type" "long" }, "specialty" { "type" "text" } } }, "company stock info collection" { "type" "nested", "properties" { "id" { "type" "long" }, "ticker" { "type" "text" } } }, "company funding rounds collection" { "type" "nested", "properties" { "id" { "type" "long" }, "last round investors count" { "type" "long" }, "total rounds count" { "type" "long", "null value" 1 }, "last round type" { "type" "keyword" }, "last round date" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss||yyyy mm dd||uuuu", "null value" "1000" }, "last round money raised" { "type" "keyword" }, "cb url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } } } } sorting options you can choose between two sorting options sort by id or score if you omit the sort part entirely, the sorting will be by id by default sorting by score enables you to view search results in order of relevance, with the most relevant items appearing first sorting by id arranges the list of ids in ascending order, starting from the smallest value and progressing to the largest choose the sorting type in the sort section of the endpoint payload endpoint payload { "query" {}, "sort" \[ null ] } sort by score { "query" { "match" { "name" { "query" "example company", "operator" "and" } } }, "sort" \[ " score" ] } sort by id { "query" { "bool" { "filter" \[ { "range" { "employees count" { "gte" 100 } } } ] } }, "sort" \[ "id" ] } all company information mentioned within this context is entirely fictional and is solely intended for illustrative purposes limitations we do not own the functions and syntax that this endpoint operates in for all specific elasticsearch dsl information, please refer to their official documentation the endpoint accepts the query object of a standard elasticsearch request refer to the request examples elasticsearch docid\ h0acdhs zzk tf qodcam no matter the content of the query, the search only returns record ids (like all other search endpoints) queries in this endpoint are limited to 15,000 characters the maximum number of clauses a booleanquery can contain (number of boolean operators within the query) is 1024 more information on elasticsearch dsl do your elasticsearch dsl endpoints support analytics features? no, the analytics features are not supported in our elasticsearch dsl endpoints is it possible to search for a boolean value? yes the elastic search query itself includes a parameter bool that indicates to return results if they meet the criteria is there a way to exclude results? use an elastic search boolean query with a must not clause