get_brazil_cep {BrazilDataAPI} | R Documentation |
Get Address Information by Brazilian CEP (Postal Code)
Description
This function retrieves detailed address information for a given Brazilian postal code (CEP) using the BrasilAPI endpoint.
Usage
get_brazil_cep(cep)
Arguments
cep |
A valid Brazilian postal code (CEP) with 8 digits (e.g., "89010025"). |
Details
Example URL format: https://brasilapi.com.br/api/cep/v1/89010025
Replace 89010025
with any valid Brazilian postal code (CEP).
The function sends a GET request to the BrasilAPI CEP endpoint. If the request
is successful and the response contains the expected fields, it returns a
structured tibble. Otherwise, a message is displayed and NULL
is returned.
Value
A data frame (tibble) with the following columns:
-
cep
: The CEP (postal code). -
state
: State abbreviation (e.g., SP, RJ). -
city
: City or municipality. -
neighborhood
: Neighborhood. -
street
: Street name. -
service
: Name of the API service used.
Note
Requires an internet connection. Make sure the CEP is correctly formatted (only digits, 8 characters).
See Also
Examples
## Not run:
# Look up information for a specific CEP
get_brazil_cep("89010025")
## End(Not run)