Response Format
Every successful endpoint returns JSON. All list and data responses
include a metadata.resultset object describing pagination.
Shared Pagination Object
| Field | Type | Description |
|---|---|---|
metadata.resultset.count | number | Total number of records available |
metadata.resultset.offset | number | Number of records skipped |
metadata.resultset.limit | number | Maximum records in this response |
GET /v1/datasets
Response Fields
| Field | Type | Description |
|---|---|---|
metadata | object | Wrapper containing pagination metadata |
metadata.resultset | object | Pagination state (see shared object above) |
results[] | array | Array of dataset objects |
results[].config | string | Dataset config name, used in path parameters |
results[].name | string | Human-readable dataset title |
results[].category | string | Topic category (economy, agriculture, governance) |
results[].description | string | Short description of the dataset |
results[].source | string | Institution that publishes the data |
results[].url | string | Link to the original source |
GET /v1/datasets/{config_name}
Response Fields
| Field | Type | Description |
|---|---|---|
metadata | object | Wrapper containing pagination metadata |
metadata.resultset | object | Pagination state (see shared object above) |
category | string | Topic category (economy, agriculture, governance) |
source | string | Institution that publishes the data |
description | string | Short description of the dataset |
url | string | Link to the original source |
results[] | array | Array of data records. Fields correspond to the dataset's columns |
GET /v1/datasets/{config_name}/info
Response Fields
| Field | Type | Description |
|---|---|---|
config | string | Dataset config name |
name | string | Human-readable dataset title |
category | string | Topic category |
description | string | Short description of the dataset |
source | string | Institution that publishes the data |
url | string | Link to the original source |
GET /v1/datasets/{config_name}/schema
Response Fields
| Field | Type | Description |
|---|---|---|
config | string | Dataset config name |
category | string | Topic category |
name | string | Human-readable dataset title |
source | string | Institution that publishes the data |
row_count | number | Total number of records in the dataset |
columns[] | array | Column definitions (see below) |
Column Object Fields
| Field | Type | Description |
|---|---|---|
name | string | Column name |
type | string | Data type (int64, float64, object) |
description | string | What the column represents |
nullable | boolean | Whether null values are allowed |
null_count | number | Number of null values |
sample_values | array | Up to 5 example values from the column |
stats | object|null | Numeric summary (mean, std, min, max, quartiles) for numeric columns; null for non-numeric |