blob: c028b020bd7b944ac8bdea4e457c93e47ab5433e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
#' cepis: client for the public CEP API at cep.is
#'
#' @description
#' Resolves Brazilian postal codes against <https://cep.is>. Official
#' Correios data (DNE), refreshed every two weeks.
#'
#' ```r
#' address <- cep_lookup("01001-000")
#' address$logradouro # "Praca da Se"
#' address$localidade # "Sao Paulo"
#' ```
#'
#' The API surface is English, but the **data fields keep the API's own
#' Portuguese names** (`logradouro`, `bairro`, `localidade`, `uf`). What you
#' read in the JSON at <https://cep.is/01001000> is what you read on the
#' returned object, with no translation layer in between.
#'
#' Start at [cep_lookup()] for one CEP, [cep_lookup_many()] for many,
#' [cep_health()] for the API's status and [cepis_client()] for anything
#' beyond the default configuration. Failures are classed conditions,
#' described in [cepis_conditions].
#'
#' @keywords internal
"_PACKAGE"
|