get_dataset_by_path_v1_datasets__provider___dataset__get
Fetch dataset data or subdataset list by specifying provider and dataset path. Supports pagination, format selection, sorting, grouping, and aggregation.
Instructions
GET /v1/datasets/{provider}/{dataset} (public) — Get Dataset By Path — Get dataset data (flat) or subdataset list (hierarchical).
For flat datasets: Returns paginated data with full query support. For hierarchical datasets: Returns list of subdatasets.
Metadata is available at GET /v1/datasets/{provider}/{dataset}/meta
Format Selection (in priority order):
Accept header: application/json, text/csv, text/tab-separated-values, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.apache.parquet
?format query param: json, csv, tsv, xlsx, parquet
csv/tsv/xlsx/parquet always return file attachments with the full dataset (size-guarded at MAX_DOWNLOAD_SIZE_BYTES). ?format=json also returns the full dataset as a JSON file; without ?format=json, JSON …
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| provider | Yes | ||
| dataset | Yes | ||
| format | No | Output format: json, csv, tsv, xlsx, parquet | |
| limit | No | ||
| offset | No | ||
| cursor | No | Cursor for keyset pagination (from next_cursor in previous response) | |
| view | No | View: 'flat', 'timeseries', or custom grouping params | |
| expand | No | Comma-separated fields to expand (e.g., 'area,item') | |
| fields | No | Comma-separated columns to include (e.g., 'date,value') | |
| sort | No | Column to sort by. Prefix with - for descending (e.g., 'date', '-year') | |
| group_by | No | Column to group by | |
| nest_fields | No | Comma-separated columns to include in nested items | |
| nest_field | No | Name for nested array (default: 'items') | |
| sort_nested | No | Column to sort nested items by | |
| aggregate | No | Comma-separated aggregate expressions: avg(score),count(*). Supported functions: count, sum, avg, min, max, count_distinct | |
| include_sources | No | Include source attribution columns in response data | |
| response_format | No | Response format: 'columnar' (default, compact array-of-arrays) or 'objects' (array-of-dicts) | |
| debug | No | Include debug info (query echo, generated SQL) in response |