get_release_series#

async AsyncAPI.get_release_series(release_id, realtime_start=None, realtime_end=None, limit=None, offset=None, sort_order=None, filter_variable=None, filter_value=None, exclude_tag_names=None)#

Get FRED release series

Get the series in a release.

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. Default is 1000.

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

  • sort_order (str, optional) – Order results by values. Options are ‘asc’ or ‘desc’.

  • filter_variable (str, optional) – The attribute to filter results by.

  • filter_value (str, optional) – The value of the filter variable.

  • exclude_tag_names (str | list, optional) – A semicolon-separated list of tag names to exclude.

Returns:

If multiple series are returned.

Return type:

List[Series]

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
>>>     series = await fred.get_release_series(51)
>>>     for s in series:
>>>         print(s.id)
>>> asyncio.run(main())
'BOMTVLM133S'
'BOMVGMM133S'
'BOMVJMM133S'...
FRED API Documentation:

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