API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Datasets

List all datasets

datasets().list(DatasetListParamsparams = DatasetListParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : DatasetList

GET/api/v1/datasets

Create a new dataset (admin only)

datasets().create(DatasetCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : Dataset

POST/api/v1/datasets

Get dataset by ID

datasets().retrieve(DatasetRetrieveParamsparams = DatasetRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : Dataset

GET/api/v1/datasets/{id}

Delete a dataset

datasets().delete(DatasetDeleteParamsparams = DatasetDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/api/v1/datasets/{id}

Query features in a dataset

datasets().features(DatasetFeaturesParamsparams = DatasetFeaturesParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection

GET/api/v1/datasets/{id}/features

ModelsExpand Collapse

class Dataset:

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

id: String

Dataset UUID

formatuuid

insertedAt: LocalDateTime

Creation timestamp (UTC)

formatdate-time

name: String

Human-readable dataset name

slug: String

URL-friendly identifier

updatedAt: LocalDateTime

Last update timestamp (UTC)

formatdate-time

attribution: Optional<String>

Required attribution text

description: Optional<String>

Dataset description

license: Optional<String>

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

sourceUrl: Optional<String>

URL of the original data source

formaturi

class DatasetList:

List of all available datasets.

datasets: List<Dataset>

Array of dataset metadata objects

id: String

Dataset UUID

formatuuid

insertedAt: LocalDateTime

Creation timestamp (UTC)

formatdate-time

name: String

Human-readable dataset name

slug: String

URL-friendly identifier

updatedAt: LocalDateTime

Last update timestamp (UTC)

formatdate-time

attribution: Optional<String>

Required attribution text

description: Optional<String>

Dataset description

license: Optional<String>

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

sourceUrl: Optional<String>

URL of the original data source

formaturi