A fully featured FRED API client library for Python.
Project description
pyfredapi - Python API for the Federal Reserve Economic Data (FRED)
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 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")
Documentation
Coming soon
Contributing
Coming soon
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pyfredapi-0.1.0.post2.tar.gz
.
File metadata
- Download URL: pyfredapi-0.1.0.post2.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
Algorithm | Hash digest | |
---|---|---|
SHA256 | b835b8c6f4990a7ff09327f1af7e15817434f7271aa84d6f6cf057abd8e67cb0 |
|
MD5 | da25e7486e9c14730f29267eb5d951c1 |
|
BLAKE2b-256 | 408e6f05a4863ec63936c3b0a11f083576d156ae720cd652b32eb2c7f74b5258 |
Provenance
File details
Details for the file pyfredapi-0.1.0.post2-py3-none-any.whl
.
File metadata
- Download URL: pyfredapi-0.1.0.post2-py3-none-any.whl
- Upload date:
- Size: 13.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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 343e3594d974522ae79200e7349d53500e0b18250fd3bf426d5056a028f4de6a |
|
MD5 | 14c757f9026df5d19b3ed98ce97a1760 |
|
BLAKE2b-256 | 40c248dba63da9ff0235f02d7e9cc8b2efe22201fdb5dd9c16107035f3206a3b |