Skip to main content

A fully featured FRED API client library for Python.

Project description

pyfredapi - Python API for the Federal Reserve Economic Data (FRED)

PyPi Version Supported Python Versions License

pyfredapi is a Python API for accessing the FRED API web service provided by the Federal Reserve Bank of St. Louis. pyfredapi makes it easy to retrieve economic data from FRED and ALFRED. Requests to the api can be customized according to the parameters made available by the web service.

pyfredapi aims to be a full featured api for the FRED API web service. pyfredapi provides convenient methods for requesting data series, and can return data as a pandas dataframe of as json.

Installation

pip install fredapi

Basic Usage

Before using pyfredapi and must have a API key to the FRED API web service. You can apply for one for free on the FRED website.

You can either be set as the environment variable FRED_API_KEY, or pass it to the api_key parameters when initializing pyfredapi.

from pyfredapi import FredApi

# api key set as environment variable
client = FredApi()

# api key passed to initializer
client = FredApi(api_key = "my_api_key")

# get data for the S&P500
client.get_series_data("SP500")

Documentation

Coming soon

Contributing

Coming soon

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyfredapi-0.1.0.post1.tar.gz (11.3 kB view hashes)

Uploaded Source

Built Distribution

pyfredapi-0.1.0.post1-py3-none-any.whl (13.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page