Response Format

JSON Structure

Every successful endpoint returns JSON. All list and data responses include a metadata.resultset object describing pagination.

Shared Pagination Object
FieldTypeDescription
metadata.resultset.countnumberTotal number of records available
metadata.resultset.offsetnumberNumber of records skipped
metadata.resultset.limitnumberMaximum records in this response
List Datasets

GET /v1/datasets

Response Fields

FieldTypeDescription
metadataobjectWrapper containing pagination metadata
metadata.resultsetobjectPagination state (see shared object above)
results[]arrayArray of dataset objects
results[].configstringDataset config name, used in path parameters
results[].namestringHuman-readable dataset title
results[].categorystringTopic category (economy, agriculture, governance)
results[].descriptionstringShort description of the dataset
results[].sourcestringInstitution that publishes the data
results[].urlstringLink to the original source
Single Dataset

GET /v1/datasets/{config_name}

Response Fields

FieldTypeDescription
metadataobjectWrapper containing pagination metadata
metadata.resultsetobjectPagination state (see shared object above)
categorystringTopic category (economy, agriculture, governance)
sourcestringInstitution that publishes the data
descriptionstringShort description of the dataset
urlstringLink to the original source
results[]arrayArray of data records. Fields correspond to the dataset's columns
Dataset Info

GET /v1/datasets/{config_name}/info

Response Fields

FieldTypeDescription
configstringDataset config name
namestringHuman-readable dataset title
categorystringTopic category
descriptionstringShort description of the dataset
sourcestringInstitution that publishes the data
urlstringLink to the original source
Dataset Schema

GET /v1/datasets/{config_name}/schema

Response Fields

FieldTypeDescription
configstringDataset config name
categorystringTopic category
namestringHuman-readable dataset title
sourcestringInstitution that publishes the data
row_countnumberTotal number 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
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: Error Handling