Retrieve data from the FRED API — get_fred • epidatatools

This function is simply a wrapper around fredr and requires you to have an FRED API key saved in the FRED_API_KEY environment variable.

Usage

get_fred(series, start = NULL, end = NULL, metadata = F)

Arguments

series: FRED series code
start: Start year or date (numeric year or Date object)
end: End year or date (numeric year or Date object)
metadata: Flag for additional metadata

Value

A tibble

Examples

if (FALSE) {
get_fred("UNRATE")

series = c(
  gdp = "GDP",
  urate = "UNRATE"
)

get_fred(series, start = as.Date("2024-07-01"), end = 2024)

# Tibble with list columns including additional metadata
complete_results = get_fred(series, start = 2020, end = 2025, metadata = T)
complete_results

complete_results |>
  tidyr::unnest(metadata)
}