API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Datasets

List all datasets

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

GET/api/v1/datasets

Create a new dataset (admin only)

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

POST/api/v1/datasets

Get dataset by ID

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

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

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

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.

String id

Dataset UUID

formatuuid

LocalDateTime insertedAt

Creation timestamp (UTC)

formatdate-time

String name

Human-readable dataset name

String slug

URL-friendly identifier

LocalDateTime updatedAt

Last update timestamp (UTC)

formatdate-time

Optional<String> attribution

Required attribution text

Optional<String> description

Dataset description

Optional<String> license

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

Optional<String> sourceUrl

URL of the original data source

formaturi

class DatasetList:

List of all available datasets.

List<Dataset> datasets

Array of dataset metadata objects

String id

Dataset UUID

formatuuid

LocalDateTime insertedAt

Creation timestamp (UTC)

formatdate-time

String name

Human-readable dataset name

String slug

URL-friendly identifier

LocalDateTime updatedAt

Last update timestamp (UTC)

formatdate-time

Optional<String> attribution

Required attribution text

Optional<String> description

Dataset description

Optional<String> license

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

Optional<String> sourceUrl

URL of the original data source

formaturi