fredr_series_updates: Get a set of recently updated FRED series

Description Usage Arguments Value API Documentation See Also Examples

View source: R/fredr_series_updates.R

Description

Returns information on the recently updated series on the FRED server.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
fredr_series_updates(
  ...,
  filter_value = NULL,
  start_time = NULL,
  end_time = NULL,
  limit = NULL,
  offset = NULL,
  realtime_start = NULL,
  realtime_end = NULL
)

Arguments

...

These dots only exist for future extensions and should be empty.

filter_value

Filter results by type of geographic region of economic the data series. Possible values include

  • "all" (default) - no filtering

  • "macro" - filters results macroeconomic regions (e.g. entire countries)

  • "regional" - filters results to series for regions of the United States such as states, counties, and Metropolitan Statistical Areas (MSA).

start_time

A datetime object indicating the start time to filter series updates results.

end_time

A datetime object indicating the start time to filter series updates results.

limit

An integer limit on the maximum number of results to return. Defaults to 1000, the maximum.

offset

An integer used in conjunction with limit for long series. This mimics the idea of pagination to retrieve large amounts of data over multiple calls. Defaults to 0.

realtime_start

A Date indicating the start of the real-time period. Defaults to today's date. For more information, see Real-Time Periods.

realtime_end

A Date indicating the end of the real-time period. Defaults to today's date. For more information, see Real-Time Periods.

Value

A tibble object where each row represents a series. Rows are sorted with most recently updated series appearing first.

API Documentation

fred/series/updates

See Also

fredr_series_observations(), fredr_series_search_text(), fredr_series_search_id(), fredr_series_search_tags(), fredr_series_search_related_tags(), fredr_series(), fredr_series_release(), fredr_series_tags(), fredr_series_categories(), fredr_series_vintagedates().

Examples

1
2
3
4
5
6
7
if (fredr_has_key()) {
# Get all recently updated "regional" series
fredr_series_updates(filter_value = "regional")
# Most recently udpated series are returned first
updates <- fredr_series_updates(filter_value = "regional")$last_updated
is.unsorted(rev(as.POSIXct(updates)))
}

fredr documentation built on Jan. 30, 2021, 1:06 a.m.