Skip to content
GuidesBlogPlaygroundDashboard

List all datasets

datasets.list() -> DatasetList
GET/api/v1/datasets

List all datasets

ReturnsExpand Collapse
class DatasetList:

List of all available datasets.

datasets: List[Dataset]

Array of dataset metadata objects

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

List all datasets

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_list = client.datasets.list()
print(dataset_list.datasets)
{
  "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
{
  "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"
    }
  ]
}