Documentação Técnica

Endereços - Estendido

Descrição

O dataset de Endereços Estendido retorna, além das informações contidas no dataset de Endereços, uma série de informações adicionais sobre características gerais do próprio endereço, tais como quantas vezes o endereço foi visto (independente de ser junto com a entidade consultada ou não). Além disso, é retornado um objeto principal com uma série de informações agregadas sobre todos os endereços encontrados para a empresa, simplificando trabalhos de modelagem e análise de dados. No caso dos endereços, a unificação de endereços similares é realizada através do código do prédio (building code), cuja definição pode ser vista na descrição do dataset de endereços.

Origem da Informação

Todos os endereços disponibilizados pela BigData Corp. tem como origem algum conteúdo capturado do ambiente público da internet. Esse conteúdo pode ser o HTML de uma página (como um anúncio postado em um marketplace, ou uma mensagem postada em um fórum), um documento PDF (como um processo judicial ou um artigo acadêmico), ou qualquer outro elemento que contenha informações que possam ser extraídas. A evidência de origem da informação de contato e de sua associação com a entidade consultada está disponível mediante requisição para a equipe de atendimento.

Tabela de preços para esse dataset

Consultas Realizadas no MêsValor por consulta
1 - 10000R$ 0,050
10001 - 50000R$ 0,048
50001 - 100000R$ 0,046
100001 - 500000R$ 0,044
500001 - 1000000R$ 0,042
1000001 - 5000000R$ 34.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
docDocumento de identificaçãoCNPJ🛑 Obrigatório
zipcodeEsse dataset suporta um par de parâmetros opcionais chamados zipcode e addressnumber, isso permite o sistema montar o código do BuildCode e aumentar significativamente a qualidade do resultado da consulta.CEP do endereçoℹ️  Opcional
addressnumberEsse dataset suporta um par de parâmetros opcionais chamados zipcode e addressnumber, isso permite o sistema montar o código do BuildCode e aumentar significativamente a qualidade do resultado da consulta.Número do endereçoℹ️  Opcional

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": "addresses_extended",
    "q": "doc{CNPJ}"  
}  

Filtros

CampoDescrição do filtroTipo do filtroValores Possíveis do Filtro
TypeTipo de endereçoIgualwork, home
isratifiedSe está ratificadoIgualtrue, false
isactiveSe está ativoIgualtrue, false
isrecentSe é recenteIgualtrue, false
ismainSe é principalIgualtrue, false
stateSigla do estadoIgualRJ, SP, MG, ES...
zipcodeNúmero do CEPComeça comQualquer CEP completo ou primeiros x digitos

Abaixo está um exemplo de como utilizar o parâmetro .filter(nome_do_campo=XXXX)

{  
    "Datasets": "addresses_extended.filter(Type=work)",
    "q": "doc{CNPJ}"  
}  

Limite

Para utilizar o campo de limite basta utilizar o parâmetro .limit(x)

{  
    "Datasets": "addresses_extended.limit(10)",
    "q": "doc{CNPJ}"  
}  

Paginação

A paginação do dataset pode ser feita através do parâmetro .next(x), utilizando o ID retornado pela requisição anterior e um parâmetro de consulta q com o mesmo parâmetro inserido na consulta original, conforme o exemplo abaixo:

{  
    "Datasets": "addresses_extended.next(Id da próxima página)",
    "q": "doc{CNPJ}"  
}  

Prioridade de Contato

Os retornos da nossa API te permitem identificar o que seria o melhor contato para falar com alguém de algumas formas diferentes. Primeiro, retornamos para todos os contatos um atributo de "Prioridade" (Priority), que indica, na nossa avaliação, qual seria o contato prioritário para o indivíduo. Quanto mais baixo o número, melhor.
Segundo, você pode olhar para as passagens relacionadas com os contatos. No geral, quanto mais passagens uma informação de contato tem com uma entidade, maior a relevância daquele contato para ela. Ao mesmo tempo, as passagens também entregam informações de recência (quanto tempo tem que vimos o contato para a entidade), e da quantidade de entidades associadas à um contato. Um telefone muito recente, mas que esteja associado com 50 outras pessoas, por exemplo, talvez não seja o telefone ideal para você contatar alguém.
Finalmente, os status de validação são bastante úteis para identificar contatos bons ou ruins. Um e-mail, mesmo que fortemente associado com uma entidade pelas passagens, que está marcado como inválido, com certeza não é um bom contato. Temos diferentes atributos de validação para os e-mails, telefones e endereços, e vale a pena olhar cada um dos datasets para entender quais são.
Vale ressaltar que você deve pensar no que é o melhor contato para o seu processo específico. Para alguns processos, o melhor contato pode ser o que existe a mais tempo, para outros, o mais novo, e assim por diante.

Language
Authorization
Click Try It! to start a request and see the response here!