Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zachwill/fred
Python wrapper for the St. Louis Fed's FRED API.
https://github.com/zachwill/fred
Last synced: about 1 month ago
JSON representation
Python wrapper for the St. Louis Fed's FRED API.
- Host: GitHub
- URL: https://github.com/zachwill/fred
- Owner: zachwill
- License: bsd-3-clause
- Created: 2011-04-27T22:26:25.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2016-05-13T11:37:36.000Z (over 8 years ago)
- Last Synced: 2024-10-02T07:21:35.646Z (2 months ago)
- Language: Python
- Homepage: http://api.stlouisfed.org/docs/fred/
- Size: 168 KB
- Stars: 164
- Watchers: 15
- Forks: 47
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-fintech - fred - Python wrapper for the St. Louis Fed's FRED API. (Libraries / Python)
README
fred
====
[](https://travis-ci.org/zachwill/fred)
Python wrapper of the St. Louis Federal Reserve Bank's [FRED API web
service](http://api.stlouisfed.org/docs/fred/) for retrieving economic data.
FRED API Documentation:
[http://api.stlouisfed.org/docs/fred/](http://api.stlouisfed.org/docs/fred/)
Sign up for a FRED API key:
[http://api.stlouisfed.org/api_key.html](http://api.stlouisfed.org/api_key.html)
### API Key ###
You can save your API key, and have it automatically accessible, on the command line:
$ export FRED_API_KEY=my_api_key
Usage
-----
This wrapper hopes to make working with the Fred API as easy as
possible.
```python
>>> import fred
# Save your FRED API key.
>>> fred.key('my_fred_api_key')
# Interact with economic data categories.
>>> fred.category()
>>> fred.categories(24)
>>> fred.children(24)
>>> fred.related(32073)
>>> fred.category(series=True)
>>> fred.category_series(123)
# Interact with economic data releases.
>>> fred.releases()
>>> fred.release(250)
>>> fred.dates()
# Interact with economic data series.
>>> fred.series('GNPCA')
>>> fred.series('GNPCA', release=True)
>>> fred.observations('AAA')
>>> fred.search('search term')
>>> fred.updates()
>>> fred.vintage('AAA')
# Query economic data sources.
>>> fred.sources()
>>> fred.source(23)
```
**NOTE**: Normally, data is returned in dictionary format instead of XML. If you're
looking for XML output, however, just pass in the `xml=True` keyword argument.
```python
>>> import fred
>>> fred.releases(xml=True)
```