FredAPI#

class fedfred.FredAPI(api_key, cache_mode=False, cache_size=256)[source]#

Bases: object

The FredAPI class contains methods for interacting with the Federal Reserve Bank of St. Louis FRED® API.

Parameters:

api_key (str)
cache_mode (bool)
cache_size (int)

Methods#

`FredAPI.__init__`	Initialize the FredAPI class that provides functions which query FRED data.
`FredAPI.get_category`	Get a FRED Category
`FredAPI.get_category_children`	Get a FRED Category's Child Categories
`FredAPI.get_category_related`	Get a FRED Category's Related Categories
`FredAPI.get_category_related_tags`	Get a FRED Category's Related Tags
`FredAPI.get_category_series`	Get a FRED Category's FRED Series
`FredAPI.get_category_tags`	Get a FRED Category's Tags
`FredAPI.get_related_tags`	Get FRED related tags
`FredAPI.get_release`	Get a FRED release
`FredAPI.get_release_dates`	Get FRED release dates
`FredAPI.get_release_related_tags`	Get FRED release related tags
`FredAPI.get_release_series`	Get FRED release series
`FredAPI.get_release_sources`	Get FRED release sources
`FredAPI.get_release_tables`	Get FRED release tables
`FredAPI.get_release_tags`	Get FRED release tags
`FredAPI.get_releases`	Get FRED releases
`FredAPI.get_releases_dates`	Get FRED releases dates
`FredAPI.get_series`	Get a FRED series
`FredAPI.get_series_categories`	Get FRED series categories
`FredAPI.get_series_observations`	Get FRED series observations
`FredAPI.get_series_release`	Get FRED series release
`FredAPI.get_series_search`	Get FRED series search
`FredAPI.get_series_search_related_tags`	Get FRED series search related tags
`FredAPI.get_series_search_tags`	Get FRED series search tags
`FredAPI.get_series_tags`	Get FRED series tags
`FredAPI.get_series_updates`	Get FRED series updates
`FredAPI.get_series_vintagedates`	Get FRED series vintage dates
`FredAPI.get_source`	Get a FRED source
`FredAPI.get_source_releases`	Get FRED source releases
`FredAPI.get_sources`	Get FRED sources
`FredAPI.get_tags`	Get FRED tags
`FredAPI.get_tags_series`	Get FRED tags series