Skip to content
GuidesPlaygroundDashboard

List all datasets

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

List all datasets

ReturnsExpand Collapse
class DatasetList:
datasets: List[Dataset]
id: str

Dataset ID

formatuuid
inserted_at: datetime

Creation timestamp

formatdate-time
name: str

Dataset name

slug: str

URL-friendly slug

updated_at: datetime

Last update timestamp

formatdate-time
attribution: Optional[str]

Attribution text

description: Optional[str]

Dataset description

license: Optional[str]

License identifier

source_url: Optional[str]

Source data URL

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": "name",
      "slug": "slug",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "attribution": "attribution",
      "description": "description",
      "license": "license",
      "source_url": "source_url"
    }
  ]
}
Returns Examples
{
  "datasets": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "inserted_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "slug": "slug",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "attribution": "attribution",
      "description": "description",
      "license": "license",
      "source_url": "source_url"
    }
  ]
}