diff options
Diffstat (limited to 'R/cepis-package.R')
| -rw-r--r-- | R/cepis-package.R | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/R/cepis-package.R b/R/cepis-package.R new file mode 100644 index 0000000..c028b02 --- /dev/null +++ b/R/cepis-package.R @@ -0,0 +1,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" |