Skip to main content

A full featured library 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.1.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

pyfredapi-0.5.1-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyfredapi-0.5.1.tar.gz
  • Upload date:
  • Size: 15.6 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.5.1.tar.gz
Algorithm Hash digest
SHA256 02b2f7a4df2cc76acd54cebc5a887b08b9003e5dd31786546a0daa0af5af4c85
MD5 54d81c407ddebd1b111ba5f5c6ab9b3a
BLAKE2b-256 78b6ce41db77ff73c2cf92c70162fa1c2771f3efaea8352bcb1afe3dd951a292

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyfredapi-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 21.1 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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3dae2be4b4bf0b1f25e217bb32c0a5b8deb437b8eff95b70bb78366cecccb7eb
MD5 2d3ef98aff91d3ff0d9a66965fb6983d
BLAKE2b-256 2d852ab5b7e6e3c198df1a254e43cedadb66672ffc1da0be85974a4e50a806b3

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