Documentation Index
Fetch the complete documentation index at: https://docs.sherlocker.com.br/llms.txt
Use this file to discover all available pages before exploring further.
Uma Propriedade Urbana representa uma propriedade registrada em cadastro municipal. Os dados podem vir de diferentes fontes tributárias — o campo fonte indica a origem e o campo uf o estado.
Tipagem
{
"id": "a1b2c3d4e5f6",
"fonte": "iptu",
"sql_iptu": "0123456789",
"inscricao": "0123456789",
"localizacao": {
"logradouro": "R HENRIQUE PASSINI",
"numero": "748",
"complemento": "401",
"bairro": "SERRA",
"cidade": "BELO HORIZONTE",
"uf": "MG",
"cep": "30220-380"
},
"area_terreno": 360.00,
"area_construida": 180.00,
"ano_construcao": 1995,
"tipo_uso": "RESIDENCIAL",
"valor_venal": 450000.00,
"valor_iptu": 2400.00,
"proprietario": {
"nome": "MARIA SILVA",
"documento": "12345678901",
"tipoDocumento": "CPF"
}
}
| Campo | Tipo | Descrição |
|---|
id | string | Identificador único interno |
fonte | string | Tipo de fonte tributária (ver tabela abaixo) |
sql_iptu | string | Inscrição municipal / SQL IPTU |
localizacao | object | Endereço completo do imóvel |
localizacao.uf | string | Estado — combinar com fonte para saber a origem (ex: fonte iptu + uf SP = IPTU de São Paulo) |
area_terreno | number | Área do terreno em m² |
area_construida | number | Área construída em m² |
ano_construcao | number | Ano de construção |
tipo_uso | string | RESIDENCIAL, COMERCIAL, INDUSTRIAL, TERRITORIAL |
valor_venal | number | Valor venal em R$ (base para cálculo do IPTU) |
valor_iptu | number | Valor do IPTU anual em R$ |
proprietario | object | Nome, documento (CPF/CNPJ) do proprietário |
Fontes de dados
O campo fonte indica de qual tributo/cadastro os dados foram extraídos:
| Fonte | Descrição | Dados típicos |
|---|
iptu | Imposto Predial e Territorial Urbano | Área, valor venal, tipo de uso, proprietário |
itbi | Imposto de Transmissão de Bens Imóveis | Valor de transação, comprador, vendedor |
fonte + localizacao.uf:
| Exemplo | Significa |
|---|
fonte: "iptu" + uf: "SP" | IPTU de São Paulo |
fonte: "iptu" + uf: "MG" | IPTU de Minas Gerais |
fonte: "itbi" + uf: "RJ" | ITBI do Rio de Janeiro |
Cobertura
Dados de 1.400+ municípios brasileiros via integração com portais municipais.
Conexões
- Pessoa — como proprietário (CPF)
- Empresa — como proprietário (CNPJ)
- Endereço — localização do imóvel pode ser cruzada com endereços de moradia
Endpoints
| Rota | Descrição |
|---|
GET /imoveis/cpf/{cpf} | Imóveis por proprietário (CPF) |
GET /imoveis/cnpj/{cnpj} | Imóveis por proprietário (CNPJ) |
GET /imoveis/cpf/{cpf}?uf=SP | Filtrado por estado |
