Documentação Técnica

Dados Básicos

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êsValor por consulta
1 - 10000R$ 0,030
10001 - 50000R$ 0,028
50001 - 100000R$ 0,027
100001 - 500000R$ 0,026
500001 - 1000000R$ 0,025
1000001 - 5000000R$ 21.000,00 (preço fixo)
5000001 e acimaEntre em contato

Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

CampoDescriçãoValores PossíveisTipo de Campo
zipcodeCódigo postal a consultarCEP🛑 Obrigatório
householdcodeCódigo postalInscrição da casa🔑 Chave Alternativa
buildingcodeCódigo postalInscriçã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:

ValorDescrição
SPECIALCEP para um único prédio
GENERICCEP único para um municipio todo
COMMONCEP convencional, identifica um logradouro
Language
Credentials
Click Try It! to start a request and see the response here!