Skip to contents

List available indicators from ARAD API

Source: R/arad_api.R
arad_list_indicators.Rd

This function retrieves the list of available indicators from the ARAD API. You can filter the results by providing a search term that will match indicator names (case-insensitive).

Usage

arad_list_indicators(
  set_id = NULL,
  base_id = NULL,
  indicator_id_list = NULL,
  selection_id = NULL,
  filter = NULL,
  api_key = NULL,
  base_url = "https://www.cnb.cz/aradb/api/v1",
  encoding = "windows-1250"
)

arad_get_indicators(
  set_id = NULL,
  base_id = NULL,
  indicator_id_list = NULL,
  selection_id = NULL,
  filter = NULL,
  api_key = NULL,
  base_url = "https://www.cnb.cz/aradb/api/v1",
  encoding = "windows-1250"
)

Arguments

set_id

Character, set ID to filter indicators from a specific data set (required unless base_id, indicator_id_list, or selection_id is provided)

base_id

Character, base ID to filter specific indicators (required unless set_id, indicator_id_list, or selection_id is provided)

indicator_id_list

Character vector, specific indicator IDs to retrieve (required unless set_id, base_id, or selection_id is provided). Will be converted to comma-separated string.

selection_id

Character, ID of a named selection created in ARAD user account (required unless set_id, base_id, or indicator_id_list is provided)

filter

Character, optional search term to filter indicator names (case-insensitive)

api_key

API key for ARAD access. If NULL, uses ARAD_API_KEY environment variable

base_url

Base URL for the ARAD API

encoding

Character encoding for the response (default "windows-1250")

Value

A data frame with available indicators and their metadata

Details

To use this function effectively, you need to understand ARAD's structure:

  • set_id: Identifies a data set (collection of related indicators)

  • base_id: Identifies the base indicator within a set

  • Find these IDs by browsing the ARAD web interface at https://www.cnb.cz/arad/

Examples

if (FALSE) { # \dontrun{
# Get all available indicators
indicators <- arad_list_indicators()

# Filter indicators by name (case-insensitive)
gdp_indicators <- arad_list_indicators(filter = "GDP")

# Get indicators from a specific data set
monetary_indicators <- arad_list_indicators(set_id = "MONETARY_SET")

# Get specific indicator by base_id (base part without suffix)
specific_indicator <- arad_list_indicators(base_id = "SRUMD084")

# Get specific indicators by indicator IDs
specific_indicators <- arad_list_indicators(indicator_id_list = "SRUMD08402")
multiple_indicators <- arad_list_indicators(indicator_id_list = c("SRUMD08402", "SRUMD08403"))

# Get indicators from a named selection
selection_indicators <- arad_list_indicators(selection_id = "my_selection")
} # }