Datasets

Manage microdata datasets for tax-benefit simulations.

List datasets

GET/datasets

Retrieve all available datasets.

https://v2.api.policyengine.org/datasets

Get dataset

GET/datasets/:dataset_id

Retrieve a specific dataset by ID.

Path parameters

dataset_idUUID of the dataset

https://v2.api.policyengine.org/datasets/550e8400-e29b-41d4-a716-446655440000

Create dataset

POST/datasets

Create a new dataset. The filepath should reference a file in Supabase Storage.

Request body

{
  "name": "FRS 2023-24",
  "description": "Family Resources Survey representative microdata",
  "filepath": "datasets/frs_2023_24_year_2026.h5",
  "year": 2026,
  "tax_benefit_model_version_id": "a8a20af0-b0bf-4b98-9e42-a62034f99da5"
}

https://v2.api.policyengine.org/datasets

Request parameters

namestring - Human-readable dataset name

descriptionstring | null - Optional description

filepathstring - Path to HDF5 file in storage

yearinteger - Simulation year for this dataset

tax_benefit_model_version_idUUID - Model version this dataset is compatible with

Delete dataset

DELETE/datasets/:dataset_id

Delete a dataset by ID.

Path parameters

dataset_idUUID of the dataset to delete

https://v2.api.policyengine.org/datasets/550e8400-e29b-41d4-a716-446655440000

Dataset object

idUUID - Unique identifier

namestring - Human-readable name

descriptionstring | null - Optional description

filepathstring - Path in storage bucket

yearinteger - Simulation year

created_atdatetime - Creation timestamp