An R client for the Federal Reserve Economic Data (FRED) API
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
data
docs
figure
man
tests
vignettes
.Rbuildignore
.gitattributes
.gitignore
.travis.yml
DESCRIPTION
LICENSE
Makefile
NAMESPACE
NEWS.md
README.Rmd
README.md
_pkgdown.yml
appveyor.yml
cran-comments.md
fredr.Rproj

README.md

fredr

Travis branch AppVeyor Build Status Codecov CRAN

fredr provides a complete set of R bindings to the Federal Reserve Economic Data (FRED) RESTful API, provided by the Federal Reserve Bank of St. Louis. The functions allow the user to search for and fetch time series observations as well as associated metadata within the FRED database. The core functions are

  • fredr_set_key() - Set the required FRED API key for the session.
  • fredr() or fredr_series_observations() - Fetch a FRED series.
  • fredr_series_search_text() - Search for a FRED series by text.
  • fredr_request() - Send a general request to the FRED API.

Objects are returned as tibbles. The user is strongly encouraged to read the full FRED API documentation to leverage the full power of fredr and the FRED API.

Installation

install.packages("fredr")

To get the development version of the package:

# install.packages("devtools")
devtools::install_github("sboysel/fredr")

Usage

See the Get started article.

Documentation

See the documentation site.

See Also

There are several existing R packages designed for the FRED API: