Endpoints
Generation
| Method & path | Description |
|---|---|
POST /v1/generate-dataset |
Accepts a DatasetRequest and returns the generated data for one or more tables. |
POST /v1/generate-table |
Accepts one table and returns that table's data. |
POST /v1/estimate-dataset |
Validates a generate-dataset request and returns its estimated cost, without generating data. Not billed. |
POST /v1/estimate-table |
Validates a generate-table request and returns its estimated cost, without generating data. Not billed. |
Reference data
The /v1/location routes list the countries, regions, sub-regions, cities and postal codes a
boundingLocation filter accepts in a Location or
Geospatial field.
The /v1/address routes list the same three levels for a smaller set: only the places that have
addresses. Filtering an Address field by a place that has no addresses matches
nothing, so use these routes to check a place before filtering by it.
The /v1/aviation routes list the countries, regions, airports and airlines the filters of an
Airport or Flight field accept.
| Method & path | Description |
|---|---|
GET /v1/address/countries |
Countries that have addresses. |
GET /v1/address/regions |
Regions within a country that have addresses, and the number of addresses in each. |
GET /v1/address/subregions |
Sub-regions within a region that have addresses, and the number of addresses in each. |
GET /v1/address/cities |
Cities within a region that have addresses, and the number of addresses in each. |
GET /v1/aviation/airlines |
Airlines, optionally for one country. |
GET /v1/aviation/airports |
Airports within a country, optionally filtered by region, type and scheduled service. |
GET /v1/aviation/countries |
Countries that have airports, and the number of airports in each. |
GET /v1/aviation/regions |
Regions within a country that have airports, and the number of airports in each. |
GET /v1/location/cities |
Cities within a region. |
GET /v1/location/countries |
Countries whose regions, sub-regions, cities and postal codes a filter accepts. |
GET /v1/location/world-countries |
Countries a filter accepts with no region, sub-region, city or postal code. |
GET /v1/location/postalcodes |
Postal areas within a country. |
GET /v1/location/regions |
Regions within a country. |
GET /v1/location/subregions |
Sub-regions within a region. |
GET /v1/names/countries |
Countries the Person and Name fields support. |
GET /v1/sentences/languages |
Languages the String field supports in Sentence mode. |
GET /v1/vehicles/makes |
Makes a Vehicle field accepts in makes. |
GET /v1/vehicles/manufacturers |
Makes and the manufacturer identifiers their VINs start with. |
GET /v1/vehicles/models |
Models a Vehicle field accepts in models, optionally for one make. |
GET /v1/vehicles/options |
The values each of a Vehicle field's other list filters accepts. |
GET /v1/words/languages |
Languages the String field supports in Word mode. |
Account
| Method & path | Description |
|---|---|
GET /v1/account/balance |
The account's balance and currency. |
GET /v1/account/history |
The account's usage history. |
Other
| Method & path | Description |
|---|---|
GET /health |
Returns 200 when the service is running. No API key required. |
GET /openapi/v1.json |
The API's OpenAPI document. No API key required. |
Every request other than GET /health and GET /openapi/v1.json includes your API key in the
X-Api-Key header. See
Getting Started. Generation endpoints are billed against your
credits. Estimate, reference data and account endpoints require an API key but are not billed.