read_dataset
Read actual data rows from one (asset, coin, month) partition. Defaults to the latest 200 rows. Pass columns to limit width and limit (max 1000) to limit rows — a partition can be tens of thousands of rows. For a whole partition use get_download_url.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| coin | No | Coin symbol, e.g. `BTC`. Omit for market-wide datasets (e.g. `gold_wallet_flow_1mo`) that have no coin dimension. | |
| asset | Yes | Dataset name, e.g. `gold_positioning_funding_factors_1d`. | |
| limit | No | Max rows to return (clamped to 1000). Defaults to the latest 200. | |
| month | Yes | Partition month, `YYYY-MM`. | |
| order | No | Which end of the partition to read. `latest` (default) returns the most recent rows — usually what you want for a "what's the current…" question. | |
| columns | No | Columns to return. Strongly recommended — omitting returns every column, which is wide for some datasets. Use `describe_dataset` to see columns. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| coin | No | Coin symbol; absent for market-wide datasets. | |
| note | No | Guidance when the result was capped, or other advisories. | |
| rows | Yes | One JSON object per row. | |
| asset | Yes | ||
| month | Yes | ||
| columns | Yes | The columns actually returned, in order. | |
| row_count | Yes | ||
| truncated | Yes | True when `total_rows_in_partition` exceeds the rows returned. | |
| total_rows_in_partition | Yes | Total rows in the partition (before the row cap / limit). |