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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file pyfredapi-0.1.0.post1.tar.gz.

File metadata

  • Download URL: pyfredapi-0.1.0.post1.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.1 Darwin/21.6.0

File hashes

Hashes for pyfredapi-0.1.0.post1.tar.gz
Algorithm Hash digest
SHA256 ba6c34c113a8aa1cf7badee036de16d8b7bb49ce396fc8909bce69309523b86d
MD5 deceef4e6fc5e8d6819c9d8cd9f837ac
BLAKE2b-256 97c27a5df88ec10b8f11bec3db50e69dfce4eaf9503947ac19f1dbd135661f03

See more details on using hashes here.

File details

Details for the file pyfredapi-0.1.0.post1-py3-none-any.whl.

File metadata

  • Download URL: pyfredapi-0.1.0.post1-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.1 Darwin/21.6.0

File hashes

Hashes for pyfredapi-0.1.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 5871431c1fb213325da22f0a12e10cd619af4c9f275bda0d94d014300d73c589
MD5 8ee4540b915a288a52d84e48d92378d4
BLAKE2b-256 742f20d8aff109fae092fa3fb065efff24dc16efd4f11fc112ee898be5ef56e2

See more details on using hashes here.

Supported by

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