get_series_release#

FredAPI.get_series_release(series_id, realtime_start=None, realtime_end=None)[source]#

Get FRED series release

Get the release for a specified series from the FRED API.

Parameters:

  • series_id (str) – The ID for the series.

  • realtime_start (str | datetime, optional) – The start of the real-time period. String format: YYYY-MM-DD. Defaults to None.

  • realtime_end (str | datetime, optional) – The end of the real-time period. String format: YYYY-MM-DD. Defaults to None.

Returns:

If multiple releases are returned.

Return type:

List[Release]

Raises:

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

Example

>>> import fedfred as fd
>>> fred = fd.FredAPI('your_api_key')
>>> release = fred.get_series_release('GNPCA')
>>> print(release[0].name)
'Gross National Product'
FRED API Documentation:

https://fred.stlouisfed.org/docs/api/fred/series_release.html