get_regional_data
Fetch regional values for a GeoFRED series group on a given date across states, counties, MSAs, countries, or BEA regions. Choose region type to control response size.
Instructions
GeoFRED / Maps: fetch a region cross-section for a series group — the value in every region (state, county, MSA, country, or BEA region) on a given date. All arguments are required: series_group id, region_type, date, units (a free-text measurement label FRED echoes into the title, e.g. Dollars), frequency, and season. The result nests everything under a top-level meta object (FRED's own envelope, mirrored faithfully): the dated per-region values live under meta.data, which maps each observation date to a list of {region, code, value, series_id}; alongside them sit the display labels meta.title, meta.units, meta.region, meta.seasonality, and meta.frequency (see the output schema for the full shape). Size caveat: FRED returns the full cross-section with no limit or paging, so region_type county or msa yields thousands of regions (a county cross-section can exceed 250,000 characters) — prefer state, bea, or country unless you need that granularity.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | The date to report, `YYYY-MM-DD`. | |
| units | Yes | Unit-of-measurement label — free text that FRED echoes into the result title (e.g. `Dollars`), not a transformation code. | |
| season | Yes | Seasonal adjustment. | |
| frequency | Yes | Reporting frequency. | |
| region_type | Yes | Region granularity to break the data down to. FRED returns the full cross-section with no limit or paging, so `county` or `msa` returns thousands of regions (a `county` cross-section can exceed 250,000 characters); `state`, `bea`, and `country` are far smaller. | |
| series_group | Yes | The GeoFRED series-group id, e.g. `882`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| meta | Yes | The `meta` payload: the descriptive header plus the dated regional values. |