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ês | Valor por consulta |
|---|---|
| 1 - 10.000 | R$ 0,050 |
| 10.001 - 50.000 | R$ 0,048 |
| 50.001 - 100.000 | R$ 0,046 |
| 100.001 - 500.000 | R$ 0,044 |
| 500.001 - 1.000.000 | R$ 0,042 |
| 1.000.001 - 5.000.000 | R$ 34.000,00 (preço fixo) |
| 5.000.001 e acima | Entre 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.
| Chave | Descrição | Valores Possíveis |
|---|---|---|
| zipcode | Utilizado 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 resultado | CEP |
| addressnumber | Utilizado em conjunto com o CEP para auxiliar na construção do identificador de prédio (building code), aumentando a qualidade do resultado | Número do endereço |
| useRawRFData | Instrui o sistema a retornar o endereço exatamente como capturado na Receita Federal, sem padronizações ou correções automáticas | true, false |
Para conhecer todas as chaves disponíveis e entender como combiná-las, consulte a seção Parâmetros de Consulta.
Filtros
| Campo | Descrição do filtro | Tipo do filtro | Valores Possíveis do Filtro |
|---|---|---|---|
| Type | Tipo de endereço | Igual | work, home |
| isratified | Indica se o endereço está ratificado | Igual | true, false |
| isactive | Indica se o endereço está ativo | Igual | true, false |
| isrecent | Indica se o endereço é recente | Igual | true, false |
| ismain | Indica se o endereço é principal | Igual | true, false |
| state | Sigla da unidade federativa | Igual | RJ, SP, MG, ES, ... |
| zipcode | CEP do endereço | Começa com | CEP 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.