Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Datasets

Create a new dataset (admin only)

datasets.create(DatasetCreateParams**kwargs) -> Dataset
POST/api/v1/datasets

Create a new dataset (admin only)

ParametersExpand Collapse
name: str

Human-readable dataset name

slug: str

URL-friendly identifier (lowercase, hyphens, no spaces)

attribution: Optional[str]

Required attribution text

description: Optional[str]

Dataset description

license: Optional[str]

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

source_url: Optional[str]

Source data URL

formaturi
ReturnsExpand Collapse
class Dataset: …

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

id: str

Dataset UUID

formatuuid
inserted_at: datetime

Creation timestamp (UTC)

formatdate-time
name: str

Human-readable dataset name

slug: str

URL-friendly identifier

updated_at: datetime

Last update timestamp (UTC)

formatdate-time
attribution: Optional[str]

Required attribution text

description: Optional[str]

Dataset description

license: Optional[str]

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

source_url: Optional[str]

URL of the original data source

formaturi

Create a new dataset (admin only)

import os
from plaza import Plaza

client = Plaza(
    api_key=os.environ.get("PLAZA_API_KEY"),  # This is the default and can be omitted
)
dataset = client.datasets.create(
    name="NYC Bike Lanes",
    slug="nyc-bike-lanes",
)
print(dataset.id)
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "NYC Bike Lanes",
  "slug": "nyc-bike-lanes",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "https://example.com"
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "NYC Bike Lanes",
  "slug": "nyc-bike-lanes",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "https://example.com"
}