blob: d182e04a9dcc65928b739e395420ee9df3affa92 (
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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cepis-package.R
\docType{package}
\name{cepis-package}
\alias{cepis}
\alias{cepis-package}
\title{cepis: client for the public CEP API at cep.is}
\description{
Resolves Brazilian postal codes against \url{https://cep.is}. Official
Correios data (DNE), refreshed every two weeks.
\if{html}{\out{<div class="sourceCode r">}}\preformatted{address <- cep_lookup("01001-000")
address$logradouro # "Praca da Se"
address$localidade # "Sao Paulo"
}\if{html}{\out{</div>}}
The API surface is English, but the \strong{data fields keep the API's own
Portuguese names} (\code{logradouro}, \code{bairro}, \code{localidade}, \code{uf}). What you
read in the JSON at \url{https://cep.is/01001000} is what you read on the
returned object, with no translation layer in between.
Start at \code{\link[=cep_lookup]{cep_lookup()}} for one CEP, \code{\link[=cep_lookup_many]{cep_lookup_many()}} for many,
\code{\link[=cep_health]{cep_health()}} for the API's status and \code{\link[=cepis_client]{cepis_client()}} for anything
beyond the default configuration. Failures are classed conditions,
described in \link{cepis_conditions}.
}
\seealso{
Useful links:
\itemize{
\item \url{https://cep.is}
}
}
\author{
\strong{Maintainer}: Murilo Ijanc \email{[email protected]}
}
\keyword{internal}
|