arad_search: Search indicators within an ARAD scope

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

Search indicators within an ARAD scope

Description

Searches indicator IDs and names returned by the ARAD indicators endpoint. Because ARAD does not expose an unscoped global indicator list through this endpoint, exactly one normal ARAD selector is required.

Usage

arad_search(
  term,
  indicator_ids = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  frequency = NULL,
  regex = FALSE,
  ignore_case = TRUE,
  lang = c("cs", "en"),
  api_key = NULL,
  base_url = NULL,
  encoding = "windows-1250",
  cache = NULL,
  cache_dir = NULL,
  cache_max_age = NULL
)

Arguments

term	Non-empty search text or regular expression.
indicator_ids	Character vector of indicator IDs.
set_id	ARAD set ID.
base_id	ARAD base ID.
selection_id	ARAD user selection ID.
frequency	Optional frequency code(s) to retain.
regex	Interpret term as a regular expression.
ignore_case	Ignore case while matching.
lang	Metadata language: cs or en.
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.
cache_dir	Optional disk cache directory.
cache_max_age	Maximum cache age in seconds.

Value

A filtered indicator metadata tibble.

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