get_release#

async AsyncAPI.get_release(release_id, realtime_start=None, realtime_end=None)#

Get a FRED release

Get the release 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.

Returns:

If multiple releases are returned.

Return type:

List[Release]

Raises:

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

Example

>>> >>> import fedfred as fd
>>> import asyncio
>>> async def main():
>>>     fred = fd.FredAPI('your_api_key').Async
>>>     release = await fred.get_release(53)
>>>     print(release.name)
>>> asyncio.run(main())
'Gross Domestic Product'
FRED API Documentation:

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