Documentação Técnica

Círculos - Vizinhos

Descrição

Os datasets de círculos retornam informações agregadas de pessoas relacionadas a entidade consultada, de acordo com o tipo de relacionamento entre elas. Cada círculo é um dataset separado, podendo ser consultado de forma independente. O círculo de vizinhos usa as informações de endereço, olhando para distâncias geográficas e características do CEP, do município e do bairro, para relacionar as pessoas, agregando esses relacionamentos nos resultados descritos abaixo.

Origem da Informação

Todas as informações dos círculos são calculadas como inferências sobre os agrupamentos de relacionamentos estabelecidos. Os relacionamentos tem diferentes origens, de acordo com os seus tipos, que podem ser visualizadas nos seus datasets específicos.

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çãoCPF🛑 Obrigatório

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": "circles_neighbors",
    "q": "doc{CPF}"  
}  

Notas

  • Todo círculo tem pelo menos uma pessoa, que é a própria pessoa sendo consultada.
  • O retorno de todos os datasets de círculos está contido em um único campo, "Circles", do objeto principal de retorno do serviço
Language
Credentials
Click Try It! to start a request and see the response here!