get_category_related

FredAPI.get_category_related(category_id, realtime_start=None, realtime_end=None)

Get a FRED Category’s Related Categories

Get related categories for a given category ID from the FRED API.

Parameters:

• category_id (int) – The ID for the category.

• 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 categories are returned.

Return type:

List[Category]

Raises:

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

Example

>>> import fedfred as fd
>>> fred = FredAPI('your_api_key')
>>> related = fred.get_category_related(32073)
>>> for category in related:
>>>     print(category.name)
'Arkansas'
'Illinois'
'Indiana'
'Kentucky'
'Mississippi'
'Missouri'
'Tennessee'

FRED API Documentation:

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