get_source_metadata_fred: Retrieve metadata for a FRED series

In investdatar: Investment Data Access and Preparation Toolkit

Retrieve metadata for a FRED series

Description

Queries the FRED API to obtain basic metadata of a given series, such as title, observation range, frequency, units, and seasonal adjustment.

Usage

get_source_metadata_fred(series_id, config = NULL)

Arguments

series_id	A character string. The FRED series ID (e.g., "AMERIBOR").
config	A list containing API configuration with elements: api_key Your FRED API key as a character string. url Base URL of the FRED API endpoint for series (e.g., "https://api.stlouisfed.org/fred/series"). mode File type to request, usually "json".

Value

A list with elements:

• title — Series title

• start — Observation start date

• end — Observation end date

• freq — Data frequency

• units — Measurement units

• season — Seasonal adjustment type

Examples

## Not run: 
config <- list(
  api_key = "your_api_key",
  url = "https://api.stlouisfed.org/fred/series",
  mode = "json"
)
get_source_metadata_fred("AMERIBOR", config)

## End(Not run)

investdatar documentation built on Aug. 21, 2026, 5:17 p.m.