Return basic information for a FRED series.

Given a series ID, return basic information for a FRED series. Note that this function will not return the actual series data. For this functionality, see fredr_series_observations().

fredr_series(series_id, ..., realtime_start = NULL, realtime_end = NULL)

Arguments

series_id

A string ID for the FRED series.

...

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

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 (1 row) with information for the series specified by series_id.

API Documentation

fred/series

See also

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

Examples

if (fredr_has_key()) {
# Return information for the "UNRATE" series
fredr_series(series_id = "UNRATE")
}
#> # A tibble: 1 × 15
#>   id     realtime_start realtime_end title     observation_start observation_end
#>   <chr>  <chr>          <chr>        <chr>     <chr>             <chr>          
#> 1 UNRATE 2023-04-17     2023-04-17   Unemploy… 1948-01-01        2023-03-01     
#> # ℹ 9 more variables: frequency <chr>, frequency_short <chr>, units <chr>,
#> #   units_short <chr>, seasonal_adjustment <chr>,
#> #   seasonal_adjustment_short <chr>, last_updated <chr>, popularity <int>,
#> #   notes <chr>