Correios CEP

v0.3.0

Correios CEP v0.3.0 Correios.CEP View Source

Find Brazilian addresses by zipcode, directly from Correios database. No HTML parsers.

Link to this section Summary

Functions

find_address!(zipcode, options \\ [])

Find address by a given zip code

find_address(zipcode, options \\ [])

Find address by a given zip code

Link to this section Functions

Link to this function find_address!(zipcode, options \\ []) View Source 
find_address!(String.t(), list()) :: Correios.CEP.Address.t()

Find address by a given zip code.

Similar to find_address/2 except it will unwrap the error tuple and raise in case of errors.

Examples 

iex> Correios.CEP.find_address!("54250610")
%Correios.CEP.Address{
  city: "Jaboatão dos Guararapes",
  complement: "",
  neighborhood: "Cavaleiro",
  state: "PE",
  street: "Rua Fernando Amorim",
  zipcode: "54250610"
}

iex> Correios.CEP.find_address!("00000-000")
** (Correios.CEP.Error) CEP NAO ENCONTRADO

iex> Correios.CEP.find_address!("1234567")
** (Correios.CEP.Error) zipcode in invalid format

iex> Correios.CEP.find_address!("")
** (Correios.CEP.Error) zipcode is required
Link to this function find_address(zipcode, options \\ []) View Source 
find_address(String.t(), list()) ::
  {:ok, Correios.CEP.Address.t()} | {:error, term()}

Find address by a given zip code.

Zip codes with and without “-“ separator are accepted.

Options

  • connection_timeout: timeout for establishing a TCP or SSL connection, in milliseconds. Default is 5000.
  • request_timeout: timeout for receiving an HTTP response from the socket. Default is 5000.

Examples 

iex> Correios.CEP.find_address("54250610")
{:ok,
 %Correios.CEP.Address{
   city: "Jaboatão dos Guararapes",
   complement: "",
   neighborhood: "Cavaleiro",
   state: "PE",
   street: "Rua Fernando Amorim",
   zipcode: "54250610"
 }}

iex> Correios.CEP.find_address("54250-610")
{:ok,
 %Correios.CEP.Address{
   city: "Jaboatão dos Guararapes",
   complement: "",
   neighborhood: "Cavaleiro",
   state: "PE",
   street: "Rua Fernando Amorim",
   zipcode: "54250610"
 }}

iex> Correios.CEP.find_address("54250-610", connection_timeout: 1000, request_timeout: 1000)
{:ok,
 %Correios.CEP.Address{
   city: "Jaboatão dos Guararapes",
   complement: "",
   neighborhood: "Cavaleiro",
   state: "PE",
   street: "Rua Fernando Amorim",
   zipcode: "54250610"
 }}

iex> Correios.CEP.find_address("00000-000")
{:error, %Correios.CEP.Error{reason: "CEP NAO ENCONTRADO"}}

iex> Correios.CEP.find_address("1234567")
{:error, %Correios.CEP.Error{reason: "zipcode in invalid format"}}

iex> Correios.CEP.find_address("")
{:error, %Correios.CEP.Error{reason: "zipcode is required"}}