cache: Get or manage the bbk API cache

In bbk: Client for Central Bank APIs

Get or manage the bbk API cache

Description

bbk_cache_dir() returns the path where cached API responses are stored. bbk_cache_clear() clears all cached responses.

Usage

bbk_cache_dir()

bbk_cache_clear()

Details

The cache is only used when enabled with options(bbk.cache = TRUE).

Each API's caching headers decide whether and for how long a cached response is reused, so the cache helps more with some APIs than others. APIs that allow reuse do so for minutes rather than hours. Others check a cached response with the API on every call, which only saves downloading it again, and many don't allow caching at all.

Cached responses older than 1 day are deleted. Change this with options(bbk.cache_max_age = seconds). A higher value doesn't make responses be reused for longer than the API allows.

Value

bbk_cache_dir() returns a string with the path to the cache directory.

bbk_cache_clear() is called for its side effect of clearing the cached responses and returns NULL invisibly.

Examples

## Not run: 
# enable caching
options(bbk.cache = TRUE)

# view cache location
bbk_cache_dir()

# clear the cache
bbk_cache_clear()

## End(Not run)

bbk documentation built on Oct. 21, 2026, 5:14 p.m.