arad_get: Retrieve time series from ARAD

In aradR: Modern R Client and Toolkit for the Czech National Bank ARAD API

Retrieve time series from ARAD

Description

Reliability-first retrieval of ARAD time series. Exactly one selector must be supplied. With strategy = "auto", long date ranges are split into deterministic, non-overlapping chunks; omitted boundaries are resolved through the ARAD updates endpoint. Optional raw-response caching is explicit and disabled by default.

Usage

arad_get(
  indicator_ids = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  from = NULL,
  to = NULL,
  months_before = NULL,
  snapshot_ids = NULL,
  strategy = c("auto", "direct"),
  chunk_days = getOption("aradR.chunk_days", 3650L),
  api_key = NULL,
  base_url = NULL,
  encoding = "windows-1250",
  cache = NULL,
  cache_dir = NULL,
  cache_max_age = NULL
)

Arguments

indicator_ids	Character vector of indicator IDs.
set_id	ARAD set ID.
base_id	ARAD base ID.
selection_id	ARAD user selection ID.
from	Start date as a Date, YYYY-MM-DD, or YYYYMMDD.
to	End date as a Date, YYYY-MM-DD, or YYYYMMDD.
months_before	Optional positive integer; an ARAD-native alternative to from/to.
snapshot_ids	Optional snapshot IDs, or ALL / LAST.
strategy	Retrieval strategy. auto uses bounded requests; direct makes one data request.
chunk_days	Maximum inclusive date span of each automatic chunk. The 3650-day default is calibrated by the package's live reliability audit.
api_key	ARAD API key. If NULL, ARAD_API_KEY is used.
base_url	ARAD API base URL. Primarily intended for testing.
encoding	Response encoding. Defaults to Windows-1250.
cache	Response cache mode: none, session, or disk. NULL uses the aradR.cache option, defaulting to none.
cache_dir	Optional disk cache directory.
cache_max_age	Maximum cache age in seconds. NULL uses the aradR.cache_max_age option, defaulting to Inf.

Value

A tibble with columns indicator_id, snapshot_id, period, and value. Retrieval diagnostics are stored in the arad_diagnostics attribute.

aradR documentation built on Oct. 15, 2026, 5:08 p.m.