Skip to main content
GET
Export dataset listing

Authorizations

apiKey
string
query
required

Your API key, passed as the apiKey query parameter on every request. A key sent in a header (Authorization or X-API-Key) is not accepted and gets 401.

Query Parameters

format
enum<string>
default:all

List one format only: csv, csv-zstd, ndjson, parquet or mmdb. The default, all, lists every format your plan includes. A format your plan does not include gets 403.

Available options:
all,
csv,
csv-zstd,
ndjson,
parquet,
mmdb

Response

Successful Response

build
string | null
required

The build's version, from its manifest.

generated_at
string | null
required

When the build was generated, in ISO 8601.

record_counts
object
required

Rows in each of the build's two tables, the network-range table and the residential points, keyed by the tables' own names (not the ranges and points values of a file's table). The window files have no entry of their own.

files
object[]
required

The files your plan includes, narrowed by format when you pass one.

readme_url
string | null
required

A signed link to the build's README.md.

manifest_url
string | null
required

A signed link to the build's manifest.json, which lists every file of the build with its checksum.

expires_in_seconds
integer
required

How long the links last: always 3600 seconds.