get_releases#

FredAPI.get_releases(realtime_start=None, realtime_end=None, limit=None, offset=None, order_by=None, sort_order=None)[source]#

Get FRED releases

Get all economic data releases from the FRED API.

Parameters:

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

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

  • limit (int, optional) – The maximum number of results to return. Default is None.

  • offset (int, optional) – The offset for the results. Default is None.

  • order_by (str, optional) – Order results by values such as ‘release_id’, ‘name’, ‘press_release’, ‘realtime_start’, ‘realtime_end’. Default is None.

  • sort_order (str, optional) – Sort results in ‘asc’ (ascending) or ‘desc’ (descending) order. Default is None.

Returns:

If multiple Releases are returned.

Return type:

List[Releases]

Raises:

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

Example

>>> import fedfred as fd
>>> fred = fd.FredAPI('your_api_key')
>>> releases = fred.get_releases()
>>> for release in releases:
>>>     print(release.name)
'Advance Monthly Sales for Retail and Food Services'
'Consumer Price Index'
'Employment Cost Index'...
FRED API Documentation:

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