get_releases_dates#

async AsyncAPI.get_releases_dates(realtime_start=None, realtime_end=None, limit=None, offset=None, order_by=None, sort_order=None, include_releases_dates_with_no_data=None)#

Get FRED releases dates

Get all release dates for economic data releases from the FRED API.

Parameters:

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

  • realtime_end (str, optional) – The end of the real-time period. 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. Options include ‘release_id’, ‘release_name’, ‘release_date’, ‘realtime_start’, ‘realtime_end’. Default is None.

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

  • include_releases_dates_with_no_data (bool, optional) – Whether to include release dates with no data. Default is None.

Returns:

If multiple release dates are returned.

Return type:

List[ReleaseDate]

Raises:

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

Example

>>> import fedfred as fd
>>> import asyncio
>>> async def main():
>>>     fred = fd.FredAPI('your_api_key').Async
>>>     release_dates = await fred.get_releases_dates()
>>>     for release_date in release_dates:
>>>         print(release_date.release_name)
>>> asyncio.run(main())
'Advance Monthly Sales for Retail and Food Services'
'Failures and Assistance Transactions'
'Manufacturing and Trade Inventories and Sales'...
FRED API Documentation:

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