Skip to content
GuidesPlaygroundDashboard

Datasets

List all datasets
client.datasets.list(RequestOptionsoptions?): DatasetList { datasets }
GET/api/v1/datasets
Create a new dataset (admin only)
client.datasets.create(DatasetCreateParams { name, slug, attribution, 3 more } body, RequestOptionsoptions?): Dataset { id, inserted_at, name, 6 more }
POST/api/v1/datasets
Get dataset by ID
client.datasets.retrieve(stringid, RequestOptionsoptions?): Dataset { id, inserted_at, name, 6 more }
GET/api/v1/datasets/{id}
Delete a dataset
client.datasets.delete(stringid, RequestOptionsoptions?): void
DELETE/api/v1/datasets/{id}
Query features in a dataset
client.datasets.features(stringid, DatasetFeaturesParams { cursor, limit } query?, RequestOptionsoptions?): FeatureCollection { features, type }
GET/api/v1/datasets/{id}/features
ModelsExpand Collapse
Dataset { id, inserted_at, name, 6 more }
id: string

Dataset ID

formatuuid
inserted_at: string

Creation timestamp

formatdate-time
name: string

Dataset name

slug: string

URL-friendly slug

updated_at: string

Last update timestamp

formatdate-time
attribution?: string | null

Attribution text

description?: string | null

Dataset description

license?: string | null

License identifier

source_url?: string | null

Source data URL

DatasetList { datasets }
datasets: Array<Dataset { id, inserted_at, name, 6 more } >
id: string

Dataset ID

formatuuid
inserted_at: string

Creation timestamp

formatdate-time
name: string

Dataset name

slug: string

URL-friendly slug

updated_at: string

Last update timestamp

formatdate-time
attribution?: string | null

Attribution text

description?: string | null

Dataset description

license?: string | null

License identifier

source_url?: string | null

Source data URL