get_series_group

async AsyncMapsAPI.get_series_group(series_id)

Get a GeoFRED series group

This request returns the meta information needed to make requests for FRED data. Minimum and maximum date are also supplied for the data range available.

Parameters:

series_id (str, required) – The FRED series id you want to request maps meta information for. Not all series that are in FRED have geographical data.

Returns:

If multiple series groups are returned.

Return type:

List[SeriesGroup]

Raises:

ValueError – If the API request fails or returns an error.

Example

>>> import fedfred as fd
>>> import asyncio
>>> async def main():
>>>     fred = fd.FredMapsAPI('your_api_key').Async.Maps
>>>     series_group = await fred.get_series_group('SMU56000000500000001')
>>>     print(series_group)
>>> asyncio.run(main())
'State Personal Income'

FRED API Documentation:

https://fred.stlouisfed.org/docs/api/geofred/series_group.html