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

Uploaded Source

Built Distribution

pyfredapi-0.5.3-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyfredapi-0.5.3.tar.gz
  • Upload date:
  • Size: 16.4 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.3.tar.gz
Algorithm Hash digest
SHA256 49e408f870d521e7f1ef9b84b3785d94382f17ae4a199d3d9a981332be805a07
MD5 42303c01a9be4e3e4b14a10ad7c05546
BLAKE2b-256 2c93b94dc51dce1d9888f27165b4d3bf22bbd560b2bef8c0b595f3349a0cb3b4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyfredapi-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 21.7 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ff61cc558056a02d0ddf66f64d03450ead4b05b443b4759a1b8f9ebb4a959409
MD5 0a6298b38395e108a55e6257a634fb59
BLAKE2b-256 989812f334f0013533859d5d727b08aa7ec9dd71016fe1eb04664e6f1ae15544

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