Localities for an aggregate — ibge

Retrieves available localities for an aggregate at one or more geographic levels. Validates the requested level(s) against the aggregate metadata before querying.

Usage

ibge_localities(aggregate, level = "N6", validate = TRUE)

Arguments

aggregate: Numeric aggregate identifier.
level: Geographic level. Use "N1" (Brazil), "N2" (region), "N3" (state), "N6" (municipality), "N7" (metropolitan area), etc. For multiple levels, use a vector: c("N6", "N7").
validate: Logical. If TRUE (default), validates level against aggregate metadata. Use FALSE to skip.

Value

A tibble with columns: id, name, level_id, level_name

Details

When several levels are requested, one request is made per level and the results are combined. (The API's own multi-level endpoint returns an empty list when any of the requested levels has no localities for the aggregate, which would silently hide the other levels.)

Examples

if (FALSE) { # interactive()
ibge_localities(1437, level = "N1")
ibge_localities(1437, level = c("N2", "N3"))
}