Endereços

Descrição

Dataset que reúne endereços associados à empresa consultada, incluindo informações agregadas e atributos que descrevem características do endereço, como recência, prioridade, status de atividade e tipo de vínculo. O retorno considera a consolidação de endereços similares por meio de identificadores de prédio (building code), permitindo análises mais consistentes e redução de duplicidades em cenários de modelagem e enriquecimento de dados.

Para mais informações sobre contexto de negócio, aplicações e casos de uso, consulte a documentação de Contatos.

Nome técnico do dataset: addresses_extended.

Tabela de preços

Consultas Realizadas no MêsValor por consulta
1 - 10.000R$ 0,050
10.001 - 50.000R$ 0,048
50.001 - 100.000R$ 0,046
100.001 - 500.000R$ 0,044
500.001 - 1.000.000R$ 0,042
1.000.001 - 5.000.000R$ 34.000,00 (preço fixo)
5.000.001 e acimaEntre em contato

Chaves complementares relevantes

As chaves abaixo representam algumas das chaves complementares aceitas neste dataset, permitindo refinar a consulta ou alterar a forma como os dados são analisados e retornados.

ChaveDescriçãoValores Possíveis
zipcodeUtilizado em conjunto com o número do endereço para auxiliar na construção do identificador de prédio (building code), aumentando a qualidade do resultadoCEP
addressnumberUtilizado em conjunto com o CEP para auxiliar na construção do identificador de prédio (building code), aumentando a qualidade do resultadoNúmero do endereço
useRawRFDataInstrui o sistema a retornar o endereço exatamente como capturado na Receita Federal, sem padronizações ou correções automáticastrue, false

Para conhecer todas as chaves disponíveis e entender como combiná-las, consulte a seção Parâmetros de Consulta.

Filtros

CampoDescrição do filtroTipo do filtroValores Possíveis do Filtro
TypeTipo de endereçoIgualwork, home
isratifiedIndica se o endereço está ratificadoIgualtrue, false
isactiveIndica se o endereço está ativoIgualtrue, false
isrecentIndica se o endereço é recenteIgualtrue, false
ismainIndica se o endereço é principalIgualtrue, false
stateSigla da unidade federativaIgualRJ, SP, MG, ES, ...
zipcodeCEP do endereçoComeça comCEP completo ou primeiros dígitos

Limite e Paginação

Este dataset permite limitar a quantidade de registros retornados utilizando o modificador .limit(x) no campo Datasets e, quando houver mais registros disponíveis, é possível paginar os resultados utilizando o modificador .next(x).

Para entender como aplicar filtros, limitar a quantidade de resultados, fazer paginação e personalizar o retorno dos dados, consulte a seção Personalizar Retorno.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Objeto de requisição para consulta ao dataset na API de Empresas. Para mais informações sobre cada parâmetro e sua utilização, consulte a página "Estrutura da Consulta" na seção "Primeiros Passos".

string
required

String que define os parâmetros de entrada da consulta, utilizada para informar os identificadores e filtros aplicáveis ao dataset.

string
required

String contendo os nomes técnicos dos datasets a serem consultados.

number

Número máximo de entidades retornadas na resposta, utilizado em consultas realizadas sem uma chave principal. Valor máximo permitido: 80

Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json