Central Banks & Monetary

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

Changed on

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.

get/api/v1/fred/regional

Request

  • Base URL: https://sugra.ai
  • URL: https://sugra.ai/api/v1/fred/regional
  • Auth: API key in header x-api-key

Query parameters

symbolstring required

The identifier itself. In series-group mode this is the FRED series_group ID (e.g. 882); in single-series mode a series ID. Named symbol for both - there is no separate series_group parameter to send.

Example:882
is_series_groupboolean

True when symbol is a series_group ID (requires region_type, units, frequency).

region_type'bea' | 'msa' | 'frb' | 'necta' | 'state' | 'country' | 'county' | 'censusregion' nullable

Region type (required in series-group mode).

unitsstring nullable

Series units (required in series-group mode).

frequency'a' | 'q' | 'm' | 'w' | 'd' | 'wef' | 'weth' | 'wew' | 'wetu' | 'wem' | 'wesu' | 'wesa' | 'bwew' | 'bwem' nullable

Frequency aggregation (required in series-group mode).

season'sa' | 'nsa' | 'ssa'

Seasonal adjustment. Lowercase only - 'NSA' is rejected.

start_datestring nullable

Lower bound YYYY-MM-DD.

Example:2013-01-01
datestring nullable

A single observation date YYYY-MM-DD (default latest).

transform'chg' | 'ch1' | 'pch' | 'pc1' | 'pca' | 'cch' | 'cca' | 'log' nullable

Optional value transformation.

aggregation_method'avg' | 'sum' | 'eop'

Aggregation method when frequency is set.

Response

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

Example response

{
  "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": 8.532,
    "source": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ],
    "stale_since": "2026-09-08T12:00:00Z",
    "period": "2026-Q1",
    "notes": "the UKMTO report behind these counts is dated 2026-08-21 and is 11 days old"
  }
}

Changes