Skip to content
GuidesBlogPlaygroundDashboard

Datasets

List all datasets
datasets.list() -> DatasetList { datasets }
GET/api/v1/datasets
Create a new dataset (admin only)
datasets.create(**kwargs) -> Dataset { id, inserted_at, name, 6 more }
POST/api/v1/datasets
Get dataset by ID
datasets.retrieve(id) -> Dataset { id, inserted_at, name, 6 more }
GET/api/v1/datasets/{id}
Delete a dataset
datasets.delete(id) -> void
DELETE/api/v1/datasets/{id}
Query features in a dataset
datasets.features(id, **kwargs) -> FeatureCollection { features, type }
GET/api/v1/datasets/{id}/features
ModelsExpand Collapse
class Dataset { id, inserted_at, name, 6 more }

Metadata for a custom dataset. Datasets contain user-uploaded geospatial features separate from the OSM data.

id: String

Dataset UUID

formatuuid
inserted_at: Time

Creation timestamp (UTC)

formatdate-time
name: String

Human-readable dataset name

slug: String

URL-friendly identifier

updated_at: Time

Last update timestamp (UTC)

formatdate-time
attribution: String

Required attribution text

description: String

Dataset description

license: String

License identifier (e.g. CC-BY-4.0)

source_url: String

URL of the original data source

formaturi
class DatasetList { datasets }

List of all available datasets.

datasets: Array[Dataset { id, inserted_at, name, 6 more } ]

Array of dataset metadata objects

id: String

Dataset UUID

formatuuid
inserted_at: Time

Creation timestamp (UTC)

formatdate-time
name: String

Human-readable dataset name

slug: String

URL-friendly identifier

updated_at: Time

Last update timestamp (UTC)

formatdate-time
attribution: String

Required attribution text

description: String

Dataset description

license: String

License identifier (e.g. CC-BY-4.0)

source_url: String

URL of the original data source

formaturi