Skip to contents

Retrieve data from ARAD API

Source: R/arad_api.R
arad_get_data.Rd

This function retrieves data from the Czech National Bank's ARAD API for specified indicators. Data can be retrieved by indicator IDs, set ID, base ID, or selection ID, with optional date filtering and value column renaming.

Usage

arad_get_data(
  indicator_ids = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  period_from = NULL,
  period_to = NULL,
  months_before = NULL,
  rename_value = NULL,
  api_key = NULL,
  base_url = "https://www.cnb.cz/aradb/api/v1",
  process_data = TRUE,
  encoding = "windows-1250",
  dest_dir = NULL,
  force_redownload = FALSE
)

Arguments

indicator_ids

Character vector of indicator IDs to retrieve (primary method)

set_id

Character, set ID to retrieve data from a specific data set

base_id

Character, base ID to retrieve data for specific base indicators

selection_id

Character, ID of a named selection created in ARAD user account

period_from

Character, start date in YYYYMMDD format (e.g., "20200101")

period_to

Character, end date in YYYYMMDD format (e.g., "20231231")

months_before

Integer, number of months before current date to retrieve data for

rename_value

Character, new name for the 'value' column in the output

api_key

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

base_url

Base URL for the ARAD API

process_data

Logical, whether to process the raw data (default TRUE)

encoding

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

dest_dir

Character, directory where downloaded files are saved. Defaults to getOption("cnbrrr.dest_dir", tempdir())

force_redownload

Logical, if TRUE forces redownload even if file exists (default FALSE)

Value

A data frame with the requested data

Examples

if (FALSE) { # \dontrun{
# Get data for a single indicator
data <- arad_get_data("SRUMD08402C")

# Get data for multiple indicators
data <- arad_get_data(c("SRUMD08402C", "ANOTHER_ID"))

# Get data with date filtering
data <- arad_get_data("SRUMD08402C",
                      period_from = "20200101",
                      period_to = "20231231")

# Get data from a set ID
data <- arad_get_data(set_id = "1115")

# Get data from a selection with custom value column name
data <- arad_get_data(selection_id = "my_selection",
                      rename_value = "spending")

# Get recent data using months_before
recent_data <- arad_get_data("SRUMD08402C", months_before = 12)

# Save data to specific directory
data <- arad_get_data("SRUMD08402C", dest_dir = "./data")

# Force redownload of existing data
fresh_data <- arad_get_data("SRUMD08402C", force_redownload = TRUE)

# Set global destination directory
options(cnbrrr.dest_dir = "~/cnb_data")
data <- arad_get_data("SRUMD08402C")  # Will use ~/cnb_data
} # }