arad_find: Find indicators using human-readable metadata
In aradR: Modern R Client and Toolkit for the Czech National Bank ARAD API

arad_find

R Documentation

Find indicators using human-readable metadata

Description

Searches names, IDs and ARAD hierarchy paths and, by default, base/dimension metadata so a user does not need to know an indicator ID in advance. ARAD metadata endpoints remain scoped, so exactly one selector is required. Results are ordered deterministically: exact ID/name matches first, then partial ID/name matches, hierarchy-path matches and dimension matches, with stable name/ID tie-breaking.

Usage

arad_find(
  term,
  indicator_ids = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  frequency = NULL,
  search_dimensions = TRUE,
  details = TRUE,
  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 text or regular expression to search for.
`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.
`search_dimensions`	Search base and dimension labels/codes as well as names, IDs and hierarchy paths.
`details`	Add availability/update columns for matched indicators. `data_to` is the ARAD-reported availability boundary and can extend into a forecast or reporting horizon; it is not necessarily the latest observed historical date.
`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.
`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, path-aware indicator catalogue ordered by relevance. relevance_score is an ordinal score intended only to order results for the current query, and matched_in records which metadata sources matched. With details = TRUE, availability columns are included.

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