API Reference

Datasets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List all datasets

datasets.list() -> DatasetList { datasets }

GET/api/v1/datasets

List all datasets

ReturnsExpand Collapse

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

List all datasets

Ruby

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

require "plaza"

plaza = Plaza::Client.new(
  api_key: "My API Key",
  environment: "local" # defaults to "production"
)

dataset_list = plaza.datasets.list

puts(dataset_list)

200 example

{
  "datasets": [
    {
      "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

200 example

{
  "datasets": [
    {
      "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"
    }
  ]
}