GET
/
api
/
v2
/
datasets
/
{source}
/
{endpoint}

Contact us to access our diverse range of business datasets, which are available through this API and billed based on the number of rows returned.

x-api-key
string
required

This parameter specifies the private key you’ll need for Piloterr access.

​
Parameters

query
object
required

This parameter specifies the query to search for. Based on Elasticsearch Query DSL.

Examples:

  1. Match query:
{
  "query": {
    "bool": {
      "must": [
        {
          "match_phrase": {
            "name": "Spotify"
          }
        }
      ],
      "filter": [],
      "should": [],
      "must_not": []
    }
  },
  "sort": [],
  "size": 10
}
  1. Exclude companies:
{
  "query": {
    "bool": {
      "must_not": [
        {
          "terms": {
            "name.keyword": ["Facebook", "Google", "Amazon"]
          }
        }
      ]
    }
  }
}
  1. Exclude results based on multiple criteria:
{
  "query": {
    "bool": {
      "must": [
        { "match": { "company_type": "for profit" } }
      ],
      "must_not": [
        { "range": { "founded": { "lt": "2000-01-01" } } },
        { "term": { "staff_range.keyword": "1-10" } },
        { "match": { "description": "blockchain" } }
      ]
    }
  }
}
sort
list

This parameter specifies the sort order of the results. Example:

[
  { "founded": "desc" },
  { "name.keyword": "asc" }
]

This will sort results by the “founded” field in descending order, then by the “name” field in ascending order.

size
integer

This parameter specifies the number of results to return. Example:

20

This will return a maximum of 20 results.

from_
integer

This parameter specifies the starting index of the results. Example:

100

This will start returning results from the 101st match (useful for pagination).

​
Response

hits
list

List of data matching the query.

total
object

Total number of results matching the query.

max_score
number

Maximum relevance score of the matching results.

search_metadata
object
credits
object

Credits used for the query.

account_id
string

Identifier of the account.

account_name
string

Name of the account.

Was this page helpful?