https://github.com/zachspar/fred-py-api
A fully-featured FRED Command Line Interface & Python API wrapper.
https://github.com/zachspar/fred-py-api
api-wrapper cli command-line finance fred fred-api python requests research science-research
Last synced: about 2 months ago
JSON representation
A fully-featured FRED Command Line Interface & Python API wrapper.
- Host: GitHub
- URL: https://github.com/zachspar/fred-py-api
- Owner: zachspar
- License: mit
- Created: 2022-06-22T22:11:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-04T15:41:40.000Z (10 months ago)
- Last Synced: 2025-12-15T15:14:56.519Z (6 months ago)
- Topics: api-wrapper, cli, command-line, finance, fred, fred-api, python, requests, research, science-research
- Language: Python
- Homepage:
- Size: 71.3 KB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/fred-py-api)
[](https://fred-py-api.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.org/project/fred-py-api/)
[](https://codecov.io/gh/zachspar/fred-py-api)
# Fred CLI & Python API
A fully-featured FRED Command-Line Interface & Python API Wrapper.
## Table of Contents
- [Installation](#installation)
- [Homebrew](#homebrew)
- [PyPI](#pypi)
- [Python API Documentation](#python-api-documentation)
- [Wiki](#wiki)
- [FRED References](#fred-references)
- [Shell Auto-Completion](#shell-auto-completion)
- [`zsh` Completions](#zsh-completions)
- [`bash` Completions](#bash-completions)
- [`fish` Completions](#fish-completions)
## Installation:
Install `fred` in a couple of ways.
### Homebrew
`brew install fred`
### PyPI
`pip install fred-py-api`
## Python API Documentation:
- [fred-py-api Docs](https://fred-py-api.readthedocs.io/en/latest/)
## Wiki:
- [fred-py-api Wiki](https://github.com/zachspar/fred-py-api/wiki)
## FRED References:
- [Create an API Key Here](https://fredaccount.stlouisfed.org/apikey)
- [API Documentation](https://fred.stlouisfed.org/docs/api/fred/)
## Shell Auto-Completion:
Fred CLI supports auto-completion for `zsh`, `bash` and `fish` shells. See instructions
for each directly below.
### `zsh` Completions
Add this to `~/.zshrc`
```zsh
eval "$(_FRED_COMPLETE=zsh_source fred)"
eval "$(_CATEGORIES_COMPLETE=zsh_source categories)"
eval "$(_RELEASES_COMPLETE=zsh_source releases)"
eval "$(_SERIES_COMPLETE=zsh_source series)"
eval "$(_SOURCES_COMPLETE=zsh_source sources)"
eval "$(_TAGS_COMPLETE=zsh_source tags)"
```
### `bash` Completions
Add this to `~/.bashrc`
```bash
eval "$(_FRED_COMPLETE=bash_source fred)"
eval "$(_CATEGORIES_COMPLETE=bash_source categories)"
eval "$(_RELEASES_COMPLETE=bash_source releases)"
eval "$(_SERIES_COMPLETE=bash_source series)"
eval "$(_SOURCES_COMPLETE=bash_source sources)"
eval "$(_TAGS_COMPLETE=bash_source tags)"
```
### `fish` Completions
Add this to `~/.config/fish/completions/fred.fish`
```fish
_FRED_COMPLETE=fish_source fred | source
_CATEGORIES_COMPLETE=fish_source categories | source
_RELEASES_COMPLETE=fish_source releases | source
_SERIES_COMPLETE=fish_source series | source
_SOURCES_COMPLETE=fish_source sources | source
_TAGS_COMPLETE=fish_source tags | source
```