A Python application used to pull data from the US Federal Reserve.
United States Federal Reserve API
Table of Contents
What is FRED? Short for Federal Reserve Economic Data, FRED is an online database consisting of hundred of thousands of economic data time series from scores of national, international, public, and private sources. FRED, created and maintained by the Research Department at the Federal Reserve Bank of St. Louis, goes far beyond simply providing data: It combines data with a powerful mix of tools that help the user understand, interact with, display, and disseminate the data. In essence, FRED helps users tell their data stories. The purpose of this article is to guide the potential (or current) FRED user through the various aspects and tools of the database.
This library will give you the capability to query data from FRED using Python. To get started using this library all you need is an API key. To register for an API Key please go the developers resources provided by Fred.
Setup - Requirements Install:
For this particular project, you only need to install the dependencies, to use the project. The dependencies
are listed in the
requirements.txt file and can be installed by running the following command:
pip install -r requirements.txt
After running that command, the dependencies should be installed.
Setup - Local Install:
If you are planning to make modifications to this project or you would like to access it
before it has been indexed on
PyPi. I would recommend you either install this project
editable mode or do a
local install. For those of you, who want to make modifications
to this project. I would recommend you install the library in
If you want to install the library in
editable mode, make sure to run the
file, so you can install any dependencies you may need. To run the
run the following command in your terminal.
pip install -e .
If you don't plan to make any modifications to the project but still want to use it across your different projects, then do a local install.
pip install .
This will install all the dependencies listed in the
setup.py file. Once done
you can use the library wherever you want.
Setup - PyPi Install:
To install the library, run the following command from the terminal.
pip install federal-reserve-python-api
Setup - PyPi Upgrade:
To upgrade the library, run the following command from the terminal.
pip install --upgrade federal-reserve-python-api
Here is a simple example of using the
fred library to query some category
from pprint import pprint from configparser import ConfigParser from fred.client import FederalReserveClient # Initialize the Parser. config = ConfigParser() # Read the file. config.read('config/config.ini') # Get the specified credentials. api_key = config.get('main', 'api_key') # Initialize the Client. fred_client = FederalReserveClient(api_key=api_key) # Initialize the Categories Service. categories_service = fred_client.categories() # Grab a category by it's ID. pprint(categories_service.get_category(category_id='125'))
Support These Projects
Patreon: Help support this project and future projects by donating to my Patreon Page. I'm always looking to add more content for individuals like yourself, unfortuantely some of the APIs I would require me to pay monthly fees.
YouTube: If you'd like to watch more of my content, feel free to visit my YouTube channel Sigma Coding.
Questions: If you have questions please feel free to reach out to me at email@example.com
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for federal-reserve-python-api-0.1.0.tar.gz
Hashes for federal_reserve_python_api-0.1.0-py3-none-any.whl