Skip to main content

A full featured API client for the FRED API web service.

Project description

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

PyPi Version Supported Python Versions Documentation Status Maintainability Rating Code style: black

pyfredapi is a Python library for the Federal Reserve Economic Data (FRED) API web service. pyfredapi covers all the FRED api endpoints and can return data as a pandas dataframe or json. Checkout the docs to learn more.

Installation

pip install pyfredapi

Basic Usage

Before using pyfredapi and must have an 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.

import pyfredapi.series as pf

# api key set as environment variable
pf.get_series(series_id="GDP")

# api key passed to the function
pf.get_series(series_id="GDP", api_key="my_api_key")

Contributing

Thank you for your interest in contributing to pyfredapi. Check out the contributing guide to get started.

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.5.3.tar.gz (16.4 kB view hashes)

Uploaded Source

Built Distribution

pyfredapi-0.5.3-py3-none-any.whl (21.7 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