Skip to content

Latest commit

 

History

History
333 lines (302 loc) · 8.31 KB

README.md

File metadata and controls

333 lines (302 loc) · 8.31 KB
Raw

fredapi: Python API for FRED (Federal Reserve Economic Data)

fredapi is a Python API for the FRED data provided by the Federal Reserve Bank of St. Louis. fredapi provides a wrapper in python to the FRED web service, and also provides several convenient methods for parsing and analyzing point-in-time data (i.e. historic data revisions) from ALFRED

fredapi makes use of pandas and returns data to you in a pandas Series or DataFrame

Installation

pip install fredapi

Basic Usage

First you need an API key, you can apply for one for free on the FRED website. Once you have your API key, you can set it in one of three ways:

  • set it to the evironment variable FRED_API_KEY
  • save it to a file and use the 'api_key_file' parameter
  • pass it directly as the 'api_key' parameter
from fredapi import Fred
fred = Fred(api_key='insert api key here')
data = fred.get_series('SP500')

Working with data revisions

Many economic data series contain frequent revisions. fredapi provides several convenient methods for handling data revisions and answering the quesion of what-data-was-known-when.

In ALFRED there is the concept of a vintage date. Basically every observation can have three dates associated with it: date, realtime_start and realtime_end.

  • date: the date the value is for
  • realtime_start: the first date the value is valid
  • realitime_end: the last date the value is valid

For instance, there has been three observations (data points) for the GDP of 2014 Q1:

<observation realtime_start="2014-04-30" realtime_end="2014-05-28" date="2014-01-01" value="17149.6"/>
<observation realtime_start="2014-05-29" realtime_end="2014-06-24" date="2014-01-01" value="17101.3"/>
<observation realtime_start="2014-06-25" realtime_end="2014-07-29" date="2014-01-01" value="17016.0"/>

This means the GDP value for Q1 2014 has been released three times. First release was on 4/30/2014 for a value of 17149.6, and then there have been two revisions on 5/29/2014 and 6/25/2014 for revised values of 17101.3 and 17016.0, respectively.

Get first data release only (i.e. ignore revisions)

data = fred.get_series_first_release('GDP')
data.tail()

this outputs:

date
2013-04-01    16633.4
2013-07-01    16857.6
2013-10-01    17102.5
2014-01-01    17149.6
2014-04-01    17294.7
Name: value, dtype: object

Get latest data

Note that this is the same as simply calling get_series()

data = fred.get_series_latest_release('GDP')
data.tail()

this outputs:

2013-04-01    16619.2
2013-07-01    16872.3
2013-10-01    17078.3
2014-01-01    17044.0
2014-04-01    17294.7
dtype: float64

Get latest data known on a given date

fred.get_series_as_of_date('GDP', '6/1/2014')

this outputs:

date realtime_start value
2237 2013-10-01 00:00:00 2014-01-30 00:00:00 17102.5
2238 2013-10-01 00:00:00 2014-02-28 00:00:00 17080.7
2239 2013-10-01 00:00:00 2014-03-27 00:00:00 17089.6
2241 2014-01-01 00:00:00 2014-04-30 00:00:00 17149.6
2242 2014-01-01 00:00:00 2014-05-29 00:00:00 17101.3

Get all data release dates

This returns a DataFrame with all the data from ALFRED

df = fred.get_series_all_releases('GDP')
df.tail()

this outputs:

date realtime_start value
2236 2013-07-01 00:00:00 2014-07-30 00:00:00 16872.3
2237 2013-10-01 00:00:00 2014-01-30 00:00:00 17102.5
2238 2013-10-01 00:00:00 2014-02-28 00:00:00 17080.7
2239 2013-10-01 00:00:00 2014-03-27 00:00:00 17089.6
2240 2013-10-01 00:00:00 2014-07-30 00:00:00 17078.3
2241 2014-01-01 00:00:00 2014-04-30 00:00:00 17149.6
2242 2014-01-01 00:00:00 2014-05-29 00:00:00 17101.3
2243 2014-01-01 00:00:00 2014-06-25 00:00:00 17016
2244 2014-01-01 00:00:00 2014-07-30 00:00:00 17044
2245 2014-04-01 00:00:00 2014-07-30 00:00:00 17294.7

Get all vintage dates

from __future__ import print_function
vintage_dates = fred.get_series_vintage_dates('GDP')
for dt in vintage_dates[-5:]:
    print(dt.strftime('%Y-%m-%d'))

this outputs:

2014-03-27
2014-04-30
2014-05-29
2014-06-25
2014-07-30

Search for data series

You can always search for data series on the FRED website. But sometimes it can be more convenient to search programmatically. fredapi provides a search() method that does a fulltext search and returns a DataFrame of results.

fred.search('potential gdp').T

this outputs:

series id GDPPOT NGDPPOT
frequency Quarterly Quarterly
frequency_short Q Q
id GDPPOT NGDPPOT
last_updated 2014-02-04 10:06:03-06:00 2014-02-04 10:06:03-06:00
notes Real potential GDP is the CBO's estimate of the output the economy would produce with a high rate of use of its capital and labor resources. The data is adjusted to remove the effects of inflation. None
observation_end 2024-10-01 00:00:00 2024-10-01 00:00:00
observation_start 1949-01-01 00:00:00 1949-01-01 00:00:00
popularity 72 61
realtime_end 2014-08-23 00:00:00 2014-08-23 00:00:00
realtime_start 2014-08-23 00:00:00 2014-08-23 00:00:00
seasonal_adjustment Not Seasonally Adjusted Not Seasonally Adjusted
seasonal_adjustment_short NSA NSA
title Real Potential Gross Domestic Product Nominal Potential Gross Domestic Product
units Billions of Chained 2009 Dollars Billions of Dollars
units_short Bil. of Chn. 2009 $ Bil. of $

Dependencies

More Examples