Fetch Dataset
fetch_datasetFetch tidy rows from a BIS dataflow. flow_ref is "BIS,," and the VERSION IS NOT ALWAYS 1.0 — "BIS,WS_CBPOL,1.0" (central bank policy rates), "BIS,WS_XRU,1.0" (US-dollar exchange rates), but "BIS,WS_TC,2.0" (total credit). BIS re-versions flows in place, so a guessed version returns no data rather than an error; take the exact ref from list_curated_flows or search_dataflows instead of assuming one. The key string is a dot-separated dimension filter (e.g., "D.US" — frequency.country). ALWAYS pass start_period / end_period ("2020", "2020-Q1", "2020-01"): the big banking and debt flows are multi-megabyte and an unbounded request can time out.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | Dot-separated dimension key (empty for all) | |
| limit | No | Cap rows (default 5000) | |
| flow_ref | Yes | SDMX dataflow reference | |
| end_period | No | Inclusive end | |
| start_period | No | Inclusive start |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | Tidy data rows as key-value objects | |
| count | Yes | Number of data rows returned | |
| columns | Yes | Column headers from CSV | |
| flow_ref | Yes | SDMX dataflow reference used | |
| truncated | Yes | Whether result was truncated by limit | |
| source_url | Yes | BIS web URL for this dataflow |