Response Format

Response Format

Every endpoint returns JSON. The response structure varies by endpoint.

GET /

FieldTypeDescription
countnumberTotal number of datasets available
groupsobjectDatasets keyed by source slug. Each group contains an array of dataset objects.
groups.{slug}[].configstringDataset config name, used in path parameters
groups.{slug}[].namestringHuman-readable dataset title
groups.{slug}[].descriptionstringShort description of the dataset
groups.{slug}[].sourcestringInstitution that publishes the data

GET /<slug>/<config_name>

FieldTypeDescription
sourcestringInstitution that publishes the data
descriptionstringShort description of the dataset
urlstringLink to the original source data
dataarrayArray of record objects. Each record’s fields correspond to the dataset columns.

GET /schema/<slug>/<config_name>

FieldTypeDescription
configstringDataset config name
slugstringSource group slug
namestringHuman-readable dataset title
sourcestringInstitution that publishes the data
row_countnumberNumber of records in the dataset
columns[]arrayColumn definitions (see below)

Column Object Fields

FieldTypeDescription
namestringColumn name
typestringData type (int64, float64, object)
descriptionstringWhat the column represents
nullablebooleanWhether null values are allowed
null_countnumberNumber of null values in the column
sample_valuesarrayUp to 5 example values from the column
statsobject|nullNumeric summary (mean, std, min, max, quartiles) for numeric columns; null for non-numeric
Next: Datasets