Skip to main content

St. Louis Federal Reserve FRED API

Project description

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)


Usage
-----

Without your API key saved in the `fred_api_key.py` file:

>>> from fred import Fred
>>> Fred('my_api_key').category(category_id=125)

With your API key saved in the `fred_api_key` file:

>>> from fred import Fred
>>> Fred().category(category_id=125)


### Methods

* `category` -- Get economic data for a specific category.
<pre><code>
>>> Fred().category(category_id=120)
</code></pre>


* `releases` -- Get all releases of economic data.
<pre><code>
>>> Fred().releases(limit=10)

>>> Fred().releases('dates', xml_output=True)
</code></pre>


* `release` -- Get economic data for a specific release.
<pre><code>
>>> Fred().release('series', release_id=51)
</code></pre>


* `series` -- Get economic series of data.
<pre><code>
>>> Fred().series('search', search_text="money stock")

>>> Fred().series(series_id='IRA')
</code></pre>


* `sources` -- Get all of FRED's sources of economic data.
<pre><code>
>>> Fred().sources()
</code></pre>


* `source` -- Get a single source of economic data.
<pre><code>
>>> Fred().source(source_id=51)
</code></pre>


* `api` -- Generic way of interacting with the FRED API.
<pre><code>
>>> Fred().api('release', 'dates', release_id=51)

>>> Fred().api('category', category_id=119)
</code></pre>


**NOTE**: Normally, data is returned in dictionary format instead of XML. If you're
looking for XML output, however, just pass in the `xml_output=True` argument to a
method.

>>> Fred().releases(xml_output=True)


License
-------

**Author**: Zach Williams

All code released under [the Unlicense](http://unlicense.org/) (a.k.a. Public
Domain).

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

fred-1.2.tar.gz (3.5 kB view hashes)

Uploaded Source

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