Get Series
get_seriesDownload Brazilian Central Bank SGS time series by ID or English/Portuguese alias, with parquet caching, automatic chunking, and per-series failure reporting.
Instructions
Download BCB-SGS time series (the analogue of GetBCBData::gbcbd_get_series).
Long spans are split into API-friendly chunks automatically, results are
cached as parquet files, and only missing date ranges are downloaded on
subsequent calls. Failed ids are reported in failures instead of aborting
the whole request, exactly like the R package.
Rows are compact: each one has ref_date, value and series_id. The name,
unit, frequency and source of every series are in the series array, so
pair rows with series before writing prose (units differ across ids).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"series_ids": "<series_ids>"
},
"name": "get_series"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_rows | No | Maximum observations kept per series (most recent are kept). Defaults to 1000; raise it only when you really need the full history. | |
| last_date | No | End date (YYYY-MM-DD or DD/MM/YYYY). Defaults to today. | |
| use_cache | No | Reuse locally cached parquet data and download only missing date ranges. Set to false to force a fresh download. | |
| first_date | No | Start date (YYYY-MM-DD or DD/MM/YYYY). Defaults to five years before last_date. | |
| series_ids | Yes | SGS series identifiers. Each item may be a numeric SGS id (11) or a dictionary alias in English/Portuguese ('selic', 'ipca', 'desemprego', 'dolar'). Use search_series() when unsure. | |
| format_data | No | 'long' (default) returns one row per observation with series_id/series_name columns; 'wide' pivots to one column per series. | long |
| series_names | No | Optional display names, positionally aligned with series_ids (like naming a vector in R's GetBCBData). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||