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

Uploaded Source

Built Distribution

pyfredapi-0.5.4-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyfredapi-0.5.4.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.2 Darwin/22.4.0

File hashes

Hashes for pyfredapi-0.5.4.tar.gz
Algorithm Hash digest
SHA256 5e98724f0a981c6c22770d0d148724dc740f437f092b7a7d2c31905c5a14126d
MD5 19331cd5cc20f9feeb80e12bf1bd331a
BLAKE2b-256 eb19fc9a2291c5c459fe48f73b25c2178be86e69e1be80cd0b2978448ee0491f

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyfredapi-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.2 Darwin/22.4.0

File hashes

Hashes for pyfredapi-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8b145df4c38a22362c2ad53f6b27a7f8c090fd3f901cd87e18b2a2d5312f117b
MD5 986e62beb19d88717c2ad4202e3f0ed1
BLAKE2b-256 d0b52ece1c84b173b30130c445c7d19ada0010f76e5ad8acd666d75e4facc244

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