get_series_vintagedates#

async AsyncAPI.get_series_vintagedates(series_id, realtime_start=None, realtime_end=None, limit=None, offset=None, sort_order=None)#

Get FRED series vintage dates

Get the vintage dates for a given FRED series.

Parameters:

  • series_id (str) – The ID for the FRED series.

  • 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: ‘asc’ or ‘desc’.

Returns:

If multiple vintage dates are returned.

Return type:

List[VintageDate]

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
>>>     vintage_dates = await fred.get_series_vintagedates('GNPCA')
>>>     for vintage_date in vintage_dates:
>>>         print(vintage_date.vintage_date)
>>> asyncio.run(main())
'1958-12-21'
'1959-02-19'
'1959-07-19'...
FRED API Documentation:

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