get_tc_estados: Get state dictionary

In tesouror: Access Brazilian National Treasury Open Data APIs

Get state dictionary

Description

Retrieves the dictionary of states and their numeric codes. Use these codes in the p_estado / state_code parameter of other functions.

Usage

get_tc_estados(use_cache = TRUE, verbose = FALSE)

get_tc_states(use_cache = TRUE, verbose = FALSE)

Arguments

use_cache	Logical. If TRUE (default), uses an in-memory cache.
verbose	Logical. If TRUE, prints the full API URL being called. Useful for debugging or testing in a browser. Defaults to getOption("tesouror.verbose", FALSE).

Details

These are internal Treasury codes, not IBGE codes.

get_tc_states() is an English alias.

Value

A tibble with columns codigo (numeric code) and nome (name) of each state.

See Also

Other Transferencias: get_tc_municipios(), get_tc_por_estados(), get_tc_por_estados_detalhe(), get_tc_por_municipio(), get_tc_por_municipio_detalhe(), get_tc_transferencias()

Other Transferencias dictionaries: get_tc_municipios(), get_tc_transferencias()

Examples

## Not run: 
estados <- get_tc_estados()
# Use estados$codigo as values for p_estado in other functions

## End(Not run)

tesouror documentation built on May 7, 2026, 1:06 a.m.