Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference

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, format, limit, 8 more } query?, RequestOptionsoptions?): FeatureCollection { features, type }
GET/api/v1/datasets/{id}/features
ModelsExpand Collapse
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: string

Creation timestamp (UTC)

formatdate-time
name: string

Human-readable dataset name

slug: string

URL-friendly identifier

updated_at: string

Last update timestamp (UTC)

formatdate-time
attribution?: string | null

Required attribution text

description?: string | null

Dataset description

license?: string | null

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

source_url?: string | null

URL of the original data source

formaturi
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: string

Creation timestamp (UTC)

formatdate-time
name: string

Human-readable dataset name

slug: string

URL-friendly identifier

updated_at: string

Last update timestamp (UTC)

formatdate-time
attribution?: string | null

Required attribution text

description?: string | null

Dataset description

license?: string | null

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

source_url?: string | null

URL of the original data source

formaturi