get_release_dates#

FredAPI.get_release_dates(release_id, realtime_start=None, realtime_end=None, limit=None, offset=None, sort_order=None, include_releases_dates_with_no_data=None)[source]#

Get FRED release dates

Get the release dates for a given release ID from the FRED API.

Parameters:

  • release_id (int) – The ID for the release.

  • 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.

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

  • sort_order (str, optional) – The order of the results. Possible values are ‘asc’ or ‘desc’.

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

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
>>> fred = fd.FredAPI('your_api_key')
>>> release_dates = fred.get_release_dates(82)
>>> for release_date in release_dates:
>>>     print(release_date.date)
'1997-02-10'
'1998-02-10'
'1999-02-04'...
FRED API Documentation:

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