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 Documentation Status Code style: black

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 or as json.

Installation

pip install pyfredapi

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 GDP data
client.get_series_data("GDP")

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

Uploaded Source

Built Distribution

pyfredapi-0.2.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file pyfredapi-0.2.0.tar.gz.

File metadata

  • Download URL: pyfredapi-0.2.0.tar.gz
  • Upload date:
  • Size: 10.1 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.2.0.tar.gz
Algorithm Hash digest
SHA256 c566347573b6ce4a388687ed9978b19ced427dea5b72aab4833ad9b4f863f3ea
MD5 77a53c3dd23a34951abbfb94d311c518
BLAKE2b-256 18ca887a38451db23cfb4ca2a795e313e17f204654e1208ef05d947ef3eb97b3

See more details on using hashes here.

Provenance

File details

Details for the file pyfredapi-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pyfredapi-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 13.0 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 430d2b285f76ee0fd656686a85f5aac746740d91169d04fece5b4fcbc6f6193a
MD5 35498578fddb2bb8c3ede82e12c259c5
BLAKE2b-256 b5cd5af14a0add7b7f5cf03a0365f30450fcd2852520a3a172a87473ba29c525

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