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.post0.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyfredapi-0.1.0.post0.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.post0.tar.gz
Algorithm Hash digest
SHA256 f2424f61ebfe87d5fde7cf290dd8784e3e311766ee59726c38ae73cec62b4cc3
MD5 47dddba42f6834fab801cbf9e670a52b
BLAKE2b-256 840178bee7fb7beeefa5090b543e6954e9f865537913a2b837f26bf7b24df35b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyfredapi-0.1.0.post0-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.post0-py3-none-any.whl
Algorithm Hash digest
SHA256 06fe66d806021ff8043ca028fc9b0714cf8f5396afd743f0ff66496888e058c0
MD5 eda2adbb714c7d9a8c3903aa8b5ffa2c
BLAKE2b-256 686a0edf8942ce20910836544b587443d4d8f9547175ecb01041648de6bb0c3f

See more details on using hashes here.

Provenance

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