GeoFRED regional cross-section - state / MSA / county / country data for a series group

GET

/api/v1/fred/regional

Last modified:2026-09-02 16:30:21

Maintainer:Not configured

OperationId:fred_regional

Region-keyed cross-sections from the GeoFRED (FRED Maps) API. ONE call returns the whole region map.

Both modes put their identifier in symbol - there is no series_group parameter. Series-group mode (is_series_group=true) needs region_type, units and frequency alongside it; single-series mode takes a series ID and the server resolves its region group.

Working example, copy it as-is:

/api/v1/fred/regional?symbol=882&is_series_group=true&region_type=state&units=Dollars&frequency=a&season=nsa&date=2023-01-01

season values are lowercase (sa, nsa, ssa); NSA is rejected.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sugra.ai/api/v1/fred/regional?symbol=undefined&is_series_group=undefined&region_type=undefined&units=undefined&frequency=undefined&season=undefined&start_date=undefined&date=undefined&transform=undefined&aggregation_method=undefined' \
--header 'x-api-key: <api-key>'

Responses

🟢200OK

application/json

Flattened region cross-section rows (date, region, code, value, series_id, units) plus group metadata. operation_id auto-generated as fred_regional.

Bodyapplication/json

Example

{
    "data": {
        "symbol": "string",
        "region_type": "string",
        "seasonality": "string",
        "units": "string",
        "frequency": "string",
        "title": "string",
        "count": 0,
        "results": [
            {
                "date": "string",
                "region": "string",
                "code": "string",
                "value": 0,
                "series_id": "string",
                "units": "string",
                "property1": "string",
                "property2": "string"
            }
        ],
        "property1": "string",
        "property2": "string"
    },
    "meta": {
        "endpoint": "/api/v1/fred/us/cpi",
        "data_time": "2026-04-16T14:30:00Z",
        "response_time": "2026-04-16T14:30:12Z",
        "provider": "Sugra API v1.0.1",
        "data_age_days": 0,
        "source": "string",
        "attribution": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true,
        "stale": true,
        "period": "string",
        "notes": "string"
    }
}

🟠401Unauthorized

🟠422Parameter Error

🟠429

🔴503Service Unavailable

Modified at 2026-09-02 16:30:21

High Quality Market (HQM) corporate bond yield curve - full curve in one call

TIPS (Treasury Inflation-Protected Securities) yields by tenor