Descrição
O dataset de Dados Básicos de endereços retorna dois conjuntos principais de informações. O primeiro é o endereço padronizado de acordo com a base dos correios, que pode ser utilizado para correção ou preenchimento automático de campos em registros de CRM ou em qualquer situação na qual os dados padronizados sejam relevantes. O segundo são informações resumidas da quantidade de entidades associadas com o endereço, e do tempo de existência do endereço com base nessas associações.
Origem da Informação
Esse dataset reúne informações de diferentes origens públicas, consolidadas no nível do endereço, CEP, ou outro agrupamento geográfico dependendo do tipo de chave de consulta informada pelo cliente na entrada.
Tabela de preços para esse dataset
| Consultas Realizadas no Mês | Valor por consulta |
|---|---|
| 1 - 10000 | R$ 0,030 |
| 10001 - 50000 | R$ 0,028 |
| 50001 - 100000 | R$ 0,027 |
| 100001 - 500000 | R$ 0,026 |
| 500001 - 1000000 | R$ 0,025 |
| 1000001 - 5000000 | R$ 21.000,00 (preço fixo) |
| 5000001 e acima | Entre em contato |
Parâmetros de consulta
A tabela abaixo detalha os campos aceitos na consulta a este dataset.
| Campo | Descrição | Valores Possíveis | Tipo de Campo |
|---|---|---|---|
| zipcode | Código postal a consultar | CEP | 🛑 Obrigatório |
| householdcode | Código postal | Inscrição da casa | 🔑 Chave Alternativa |
| buildingcode | Código postal | Inscrição do prédio | 🔑 Chave Alternativa |
Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.
Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:
{
"Datasets": "basic_data",
"q": "zipcode{CEP}"
}
Sobre o campo ZipCodeType
O campo de ZipCodeType tem valores predefinidos, conforme abaixo:
| Valor | Descrição |
|---|---|
| SPECIAL | CEP para um único prédio |
| GENERIC | CEP único para um municipio todo |
| COMMON | CEP convencional, identifica um logradouro |