### Get Address by CEP

Source: https://viacep.com.br/ws/01001000/json_callback=callback_name

Retrieve detailed address information for a given Brazilian CEP (postal code). The response includes street name, neighborhood, city, state, and other relevant geographical data.

```APIDOC
## GET /websites/viacep_br/{cep}

### Description
Retrieves address information based on the provided Brazilian CEP code.

### Method
GET

### Endpoint
`/websites/viacep_br/{cep}`

### Parameters
#### Path Parameters
- **cep** (string) - Required - The Brazilian CEP code to search for (e.g., "01001-000").

### Request Example
```json
{
  "cep": "01001-000"
}
```

### Response
#### Success Response (200)
- **cep** (string) - The requested CEP code.
- **logradouro** (string) - The street name.
- **complemento** (string) - Complementary address information.
- **unidade** (string) - Unit information.
- **bairro** (string) - The neighborhood.
- **localidade** (string) - The city.
- **uf** (string) - The state abbreviation.
- **estado** (string) - The full state name.
- **regiao** (string) - The region.
- **ibge** (string) - IBGE code for the city.
- **gia** (string) - GIA code for the city.
- **ddd** (string) - Area code.
- **siafi** (string) - SIAFI code for the city.

#### Response Example
```json
{
  "cep": "01001-000",
  "logradouro": "Praça da Sé",
  "complemento": "lado ímpar",
  "unidade": "",
  "bairro": "Sé",
  "localidade": "São Paulo",
  "uf": "SP",
  "estado": "São Paulo",
  "regiao": "Sudeste",
  "ibge": "3550308",
  "gia": "1004",
  "ddd": "11",
  "siafi": "7107"
}
```
```

--------------------------------

### ViaCEP API JSON Response Example

Source: https://viacep.com.br/ws/01001000/json_callback=callback_name

This JSON object represents a successful response from the ViaCEP API for a given Brazilian postal code. It provides detailed address information including street, complement, neighborhood, city, state, and regional codes. The data structure is consistent for all valid CEP queries.

```json
{
  "cep": "01001-000",
  "logradouro": "Praça da Sé",
  "complemento": "lado ímpar",
  "unidade": "",
  "bairro": "Sé",
  "localidade": "São Paulo",
  "uf": "SP",
  "estado": "São Paulo",
  "regiao": "Sudeste",
  "ibge": "3550308",
  "gia": "1004",
  "ddd": "11",
  "siafi": "7107"
}
```

--------------------------------

### Auto Preenchimento de Endereço com jQuery

Source: https://viacep.com.br/index

Exemplo de como utilizar jQuery para consumir o webservice ViaCEP e preencher automaticamente os campos de endereço em um formulário com base no CEP digitado pelo usuário.

```javascript
// Exemplo de preenchimento de endereço com jQuery
$(document).ready(function() {
  $("#cep").blur(function() {
    const cep = $(this).val().replace(/\D/g, '');
    if (cep != "") {
      const url = `https://viacep.com.br/ws/${cep}/json/`;
      $.getJSON(url, function(data) {
        if (!("erro" in data)) {
          $("#logradouro").val(data.logradouro);
          $("#bairro").val(data.bairro);
          $("#localidade").val(data.localidade);
          $("#uf").val(data.uf);
        } else {
          alert("CEP não encontrado.");
        }
      });
    }
  });
});
```

--------------------------------

### Consulta CEP em JSON

Source: https://viacep.com.br/index

Exemplo de como acessar o webservice ViaCEP para obter informações de um CEP no formato JSON. O CEP deve ter 8 dígitos. Retorna detalhes como logradouro, bairro, localidade, UF, etc.

```url
viacep.com.br/ws/01001000/json/
```

--------------------------------

### Auto Preenchimento de Endereço com Javascript

Source: https://viacep.com.br/index

Exemplo de como utilizar JavaScript puro (Fetch API) para consumir o webservice ViaCEP e preencher automaticamente os campos de endereço em um formulário com base no CEP fornecido.

```javascript
// Exemplo de preenchimento de endereço com JavaScript puro
document.getElementById('cep').addEventListener('blur', function() {
  const cep = this.value.replace(/\D/g, '');
  if (cep !== '') {
    const url = `https://viacep.com.br/ws/${cep}/json/`;
    fetch(url)
      .then(response => response.json())
      .then(data => {
        if (!data.erro) {
          document.getElementById('logradouro').value = data.logradouro;
          document.getElementById('bairro').value = data.bairro;
          document.getElementById('localidade').value = data.localidade;
          document.getElementById('uf').value = data.uf;
        } else {
          alert('CEP não encontrado.');
        }
      })
      .catch(error => alert('Erro ao buscar CEP: ' + error));
  }
});
```

--------------------------------

### Consulta CEP em JSONP

Source: https://viacep.com.br/index

Exemplo de como acessar o webservice ViaCEP para obter informações de um CEP no formato JSONP, útil para requisições cross-domain. Um callback function deve ser especificado na URL.

```url
viacep.com.br/ws/01001000/json/?callback=callback_name
```

--------------------------------

### Pesquisa de CEP por Endereço em JSON

Source: https://viacep.com.br/index

Exemplo de como utilizar o webservice ViaCEP para pesquisar um CEP com base em informações de endereço (UF, Cidade, Logradouro). Retorna até 50 resultados em formato JSON, ordenados por proximidade.

```url
viacep.com.br/ws/RS/Porto Alegre/Domingos/json/
```

--------------------------------

### Consulta CEP em XML

Source: https://viacep.com.br/index

Exemplo de como acessar o webservice ViaCEP para obter informações de um CEP no formato XML. O CEP deve ter 8 dígitos. Retorna dados estruturados em tags XML.

```url
viacep.com.br/ws/01001000/xml/
```

--------------------------------

### Pesquisa de CEP por Endereço em XML

Source: https://viacep.com.br/index

Exemplo de como utilizar o webservice ViaCEP para pesquisar um CEP com base em informações de endereço (UF, Cidade, Logradouro). Retorna até 50 resultados em formato XML, ordenados por proximidade.

```url
viacep.com.br/ws/RS/Porto Alegre/Domingos/xml/
```

--------------------------------

### Tratamento de CEP Inexistente em Javascript

Source: https://viacep.com.br/index

Exemplo de código JavaScript para verificar a resposta do webservice ViaCEP quando um CEP válido é consultado, mas não é encontrado na base de dados. A resposta conterá um campo 'erro' com valor 'true'.

```javascript
// Exemplo de tratamento de erro de CEP inexistente em JavaScript
function verificarCepInexistente(resultado) {
  if (resultado.erro === true) {
    console.log("CEP não encontrado na base de dados.");
    return true;
  }
  return false;
}

// Supondo que 'resultado' seja a resposta JSON do webservice
// const resultado = {"erro": true, ...};
// if (verificarCepInexistente(resultado)) {
//   // Tratar o caso de CEP inexistente
// }
```

--------------------------------

### Search CEP by Address

Source: https://viacep.com.br/index

Allows searching for CEPs based on address components: state (UF), city, and street name (Logradouro). Supports JSON and XML response formats.

```APIDOC
## GET /ws/{UF}/{Cidade}/{Logradouro}/{FORMAT}/

### Description
Searches for CEPs based on provided address components.

### Method
GET

### Endpoint
`/ws/{UF}/{Cidade}/{Logradouro}/{FORMAT}/`

### Parameters
#### Path Parameters
- **UF** (string) - Required - The state abbreviation (e.g., 'RS').
- **Cidade** (string) - Required - The city name. Must contain at least three characters.
- **Logradouro** (string) - Required - The street name. Must contain at least three characters.
- **FORMAT** (string) - Required - The desired response format. Accepted values: `json`, `xml`.

### Request Example
`GET viacep.com.br/ws/RS/Porto Alegre/Domingos/json/`

### Response
#### Success Response (200)
Returns a list of CEPs matching the search criteria, ordered by proximity. Maximum of 50 results.
- Each item in the list typically includes:
  - **cep** (string) - The formatted CEP.
  - **logradouro** (string) - Street name.
  - **complemento** (string) - Complementary address information.
  - **bairro** (string) - Neighborhood.
  - **localidade** (string) - City.
  - **uf** (string) - State abbreviation.

#### Response Example (JSON - partial)
```json
[
  {
    "cep": "90010-000",
    "logradouro": "Rua Domingos",
    "complemento": "",
    "bairro": "Centro Histórico",
    "localidade": "Porto Alegre",
    "uf": "RS",
    "ibge": "4314100"
  }
]
```

#### Error Handling
- **400 Bad Request**: City or Logradouro name contains fewer than three characters.
```

--------------------------------

### Validação de Formato de CEP em Javascript

Source: https://viacep.com.br/index

Exemplo de código JavaScript para validar se um CEP fornecido possui o formato correto (8 dígitos numéricos) antes de realizar a consulta ao webservice ViaCEP. Ajuda a evitar requisições inválidas.

```javascript
// Exemplo de validação de formato de CEP em JavaScript
function validarCep(cep) {
  const cepRegex = /^[0-9]{8}$/;
  return cepRegex.test(cep);
}

const cepExemplo = "01001000";
if (validarCep(cepExemplo)) {
  console.log("CEP válido.");
} else {
  console.log("CEP inválido.");
}
```

--------------------------------

### Validação de Parâmetros de Pesquisa de Endereço em Javascript

Source: https://viacep.com.br/index

Exemplo de código JavaScript para validar se os parâmetros de pesquisa por endereço (UF, Cidade, Logradouro) atendem aos requisitos do webservice ViaCEP, como o número mínimo de caracteres para Cidade e Logradouro.

```javascript
// Exemplo de validação de parâmetros de pesquisa de endereço em JavaScript
function validarParametrosPesquisa(uf, cidade, logradouro) {
  if (uf.length < 1 || cidade.length < 3 || logradouro.length < 3) {
    console.error("UF, Cidade e Logradouro são necessários. Cidade e Logradouro devem ter no mínimo 3 caracteres.");
    return false;
  }
  return true;
}

// const uf = "RS";
// const cidade = "Porto Alegre";
// const logradouro = "Domingos";
// if (validarParametrosPesquisa(uf, cidade, logradouro)) {
//   // Realizar a consulta
// }
```

--------------------------------

### Query CEP by CEP Number

Source: https://viacep.com.br/index

Allows querying a specific CEP by providing the 8-digit CEP number. Supports JSON, JSONP, and XML response formats.

```APIDOC
## GET /ws/{CEP}/{FORMAT}/

### Description
Queries a specific Brazilian postal code (CEP).

### Method
GET

### Endpoint
`/ws/{CEP}/{FORMAT}/`

### Parameters
#### Path Parameters
- **CEP** (string) - Required - The 8-digit postal code to query.
- **FORMAT** (string) - Required - The desired response format. Accepted values: `json`, `xml`.

#### Query Parameters
- **callback** (string) - Optional - Used for JSONP responses. Specifies the callback function name.

### Request Example
`GET viacep.com.br/ws/01001000/json/`

### Response
#### Success Response (200)
- **cep** (string) - The formatted CEP.
- **logradouro** (string) - Street name.
- **complemento** (string) - Complementary address information.
- **unidade** (string) - Unit information.
- **bairro** (string) - Neighborhood.
- **localidade** (string) - City.
- **uf** (string) - State abbreviation.
- **estado** (string) - Full state name.
- **regiao** (string) - Region.
- **ibge** (string) - IBGE code for the city.
- **gia** (string) - GIA code (for São Paulo).
- **ddd** (string) - Area code.
- **siafi** (string) - SIAFI code.

#### Response Example (JSON)
```json
{
  "cep": "01001-000",
  "logradouro": "Praça da Sé",
  "complemento": "lado ímpar",
  "unidade": "",
  "bairro": "Sé",
  "localidade": "São Paulo",
  "uf": "SP",
  "estado": "São Paulo",
  "regiao": "Sudeste",
  "ibge": "3550308",
  "gia": "1004",
  "ddd": "11",
  "siafi": "7107"
}
```

#### Response Example (XML)
```xml
<?xml version="1.0" encoding="UTF-8"?>
<xmlcep>
    <cep>01001-000</cep>
    <logradouro>Praça da Sé</logradouro>
    <complemento>lado ímpar</complemento>
    <unidade></unidade>
    <bairro>Sé</bairro>
    <localidade>São Paulo</localidade>
    <uf>SP</uf>
    <estado>São Paulo</estado>
    <regiao>Sudeste</regiao>
    <ibge>3550308</ibge>
    <gia>1004</gia>
    <ddd>11</ddd>
    <siafi>7107</siafi>
</xmlcep>
```

#### Error Handling
- **400 Bad Request**: Invalid CEP format (e.g., non-8 digits, alphanumeric, spaces).
- **Response with `"erro": true`**: Valid CEP format but not found in the database.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.