sidra_catalog: Discover SIDRA tables

In sidrar: An Interface to IBGE's SIDRA API

Discover SIDRA tables

Description

Returns the official IBGE aggregate catalog as a rectangular table while retaining the research group to which each SIDRA table belongs.

Usage

sidra_catalog(refresh = FALSE, cache = FALSE, ttl = 1800, cache_dir = NULL)

Arguments

refresh	A single logical value. When caching is enabled, bypass and replace an existing entry.
cache	A single logical value. Cache normalized catalog or metadata responses on disk. The default is FALSE, preserving live behavior.
ttl	A positive cache lifetime in seconds. The default is 30 minutes.
cache_dir	Optional cache directory. By default, the platform-specific user cache directory for sidrar is used.

Details

The catalog is obtained from the official version 3 aggregate API. Unknown fields added by the API are ignored. Missing fields are returned as NA without changing the documented column types.

Value

A base data.frame() with columns research_id, research_name, table_id, and table_name. Identifier columns are character vectors. Research groups without tables are retained with missing table fields.

Author(s)

Renato Prado Siqueira [e-mail]

See Also

search_sidra(), sidra_metadata()

Other SIDRA discovery functions: sidra_locations(), sidra_metadata(), sidra_periods()

Examples

## Not run: 
catalog <- sidra_catalog()
subset(catalog, grepl("prices", table_name, ignore.case = TRUE))

## End(Not run)

sidrar documentation built on Sept. 18, 2026, 9:14 a.m.