POST
/
api
/
v2
/
datasets
/
{source}
/
{endpoint}
curl --request POST \
  --url https://piloterr.com/api/v2/datasets/{source}/{endpoint} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "query": {},
  "sort": [
    {}
  ],
  "size": 123,
  "from_": 123
}'
{
    "hits": [
        {
            "_id": "689823",
            "_type": "_doc",
            "_index": "xxxxx_company",
            "_score": 14.764872,
            "_source": {
                "name": "OpenAI",
                "domain": "openai.com",
                "founded": "2015-12-11",
                "website": "https://www.openai.com",
                "created_at": "2024-05-08T01:35:51.668+00:00",
                "updated_at": "2024-05-26T05:40:32.249+00:00",
                "description": "OpenAI is an AI research and deployment company that conducts research and implements machine learning. The research organization is dedicated to advancing artificial intelligence safely and beneficially.",
                "staff_range": "501-1000",
                "company_type": "for profit",
                "last_crawled_at": "2024-05-26T05:40:29.188+00:00"
            }
        }
    ],
    "total": {
        "value": 2,
        "relation": "eq"
    },
    "max_score": 14.764872,
    "search_metadata": {
        "credits": {
            "product_2_company_count": 2541156,
            "product_1_company_count": 0
        },
        "account_id": "*",
        "account_name": "*"
    }
}

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
required

It’s a required parameter. 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
{
    "hits": [
        {
            "_id": "689823",
            "_type": "_doc",
            "_index": "xxxxx_company",
            "_score": 14.764872,
            "_source": {
                "name": "OpenAI",
                "domain": "openai.com",
                "founded": "2015-12-11",
                "website": "https://www.openai.com",
                "created_at": "2024-05-08T01:35:51.668+00:00",
                "updated_at": "2024-05-26T05:40:32.249+00:00",
                "description": "OpenAI is an AI research and deployment company that conducts research and implements machine learning. The research organization is dedicated to advancing artificial intelligence safely and beneficially.",
                "staff_range": "501-1000",
                "company_type": "for profit",
                "last_crawled_at": "2024-05-26T05:40:29.188+00:00"
            }
        }
    ],
    "total": {
        "value": 2,
        "relation": "eq"
    },
    "max_score": 14.764872,
    "search_metadata": {
        "credits": {
            "product_2_company_count": 2541156,
            "product_1_company_count": 0
        },
        "account_id": "*",
        "account_name": "*"
    }
}
POST
/
api
/
v2
/
datasets
/
{source}
/
{endpoint}
curl --request POST \
  --url https://piloterr.com/api/v2/datasets/{source}/{endpoint} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "query": {},
  "sort": [
    {}
  ],
  "size": 123,
  "from_": 123
}'
{
    "hits": [
        {
            "_id": "689823",
            "_type": "_doc",
            "_index": "xxxxx_company",
            "_score": 14.764872,
            "_source": {
                "name": "OpenAI",
                "domain": "openai.com",
                "founded": "2015-12-11",
                "website": "https://www.openai.com",
                "created_at": "2024-05-08T01:35:51.668+00:00",
                "updated_at": "2024-05-26T05:40:32.249+00:00",
                "description": "OpenAI is an AI research and deployment company that conducts research and implements machine learning. The research organization is dedicated to advancing artificial intelligence safely and beneficially.",
                "staff_range": "501-1000",
                "company_type": "for profit",
                "last_crawled_at": "2024-05-26T05:40:29.188+00:00"
            }
        }
    ],
    "total": {
        "value": 2,
        "relation": "eq"
    },
    "max_score": 14.764872,
    "search_metadata": {
        "credits": {
            "product_2_company_count": 2541156,
            "product_1_company_count": 0
        },
        "account_id": "*",
        "account_name": "*"
    }
}

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
required

It’s a required parameter. 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
{
    "hits": [
        {
            "_id": "689823",
            "_type": "_doc",
            "_index": "xxxxx_company",
            "_score": 14.764872,
            "_source": {
                "name": "OpenAI",
                "domain": "openai.com",
                "founded": "2015-12-11",
                "website": "https://www.openai.com",
                "created_at": "2024-05-08T01:35:51.668+00:00",
                "updated_at": "2024-05-26T05:40:32.249+00:00",
                "description": "OpenAI is an AI research and deployment company that conducts research and implements machine learning. The research organization is dedicated to advancing artificial intelligence safely and beneficially.",
                "staff_range": "501-1000",
                "company_type": "for profit",
                "last_crawled_at": "2024-05-26T05:40:29.188+00:00"
            }
        }
    ],
    "total": {
        "value": 2,
        "relation": "eq"
    },
    "max_score": 14.764872,
    "search_metadata": {
        "credits": {
            "product_2_company_count": 2541156,
            "product_1_company_count": 0
        },
        "account_id": "*",
        "account_name": "*"
    }
}