BitBusca › Desenvolvedores › API de imóveis (cadastro municipal)
Busque o imóvel por endereço ou código na cidade e receba a ficha do cadastro da prefeitura: áreas, valor venal, zoneamento e uso. O cadastro é municipal, então a cidade vai no caminho da chamada.
Hoje: Corretor pedindo certidão ou indo à prefeitura para saber área, zoneamento e valor venal do lote. Com a API: Endereço ou código entram; a ficha do cadastro municipal volta em JSON, nas cidades atendidas.
5 créditos por ficha · escopo imoveis · a partir do Builder · planos a partir de R$ 19,90/mês. Chave de teste grátis.
O cadastro imobiliário é municipal. Hoje a API cobre as cidades abaixo — outras cidades em breve. GET /v1/imovel/cidades devolve a lista viva e o que cada uma publica; Campo Grande é a mais completa.
Campo Grande · Goiânia · Aparecida de Goiânia · Fortaleza · Dourados · Cascavel · Foz do Iguaçu — outras cidades em breve.
curl https://api.bitbusca.net/api/v1/imovel/campo-grande/0000000000 \
-H "Authorization: Bearer $BITBUSCA_API_KEY"
{
"tipo": "IMOVEL",
"consulta": "0000000000",
"custo": 5,
"dados": {
"cidade": "Campo Grande/MS",
"bairro": "CENTRO",
"areaTerreno": 360.0,
"areaConstruida": 180.5,
"valorVenal": 254300.00,
"zona": "Z3",
"uso": "Residencial"
}
}
Exemplo fictício, formato resumido. Referência completa: OpenAPI.
areaTerreno — O tamanho do lote: preço por metro e potencial do terreno.areaConstruida — O que está construído segundo o cadastro.valorVenal — O valor atribuído no cadastro da prefeitura: referência, não avaliação de mercado.zona — O zoneamento: o que a lei deixa fazer no terreno.uso — Residencial, comercial: como o lote está cadastrado.GET /v1/imovel/cidades — Cidades cobertas e os recursos de cada uma (grátis)GET /v1/imovel/busca?cidade=&termo= — Busca por endereço ou código (grátis)GET /v1/imovel/{cidade}/{codigo} — Ficha do lote (5 créditos)
Crie uma ficha de imóvel: primeiro liste as cidades com GET /v1/imovel/cidades; o usuário escolhe a cidade e digita o endereço; busque com GET /v1/imovel/busca?cidade=…&termo=… e, ao escolher o resultado, abra a ficha com GET /v1/imovel/{cidade}/{codigo}. Avise que a cobertura é por cidade.
Use a API da BitBusca (base https://api.bitbusca.net/api). A especificação OpenAPI está em https://api.bitbusca.net/api/v1/openapi.json.
Autentique com o cabeçalho "Authorization: Bearer <chave>", lendo a chave da variável de ambiente BITBUSCA_API_KEY.
Nunca coloque a chave no código do navegador: faça as chamadas por uma função de servidor (edge function, API route ou backend).
Trate os erros pelo campo "code" da resposta: 402 NO_CREDITS (sem créditos), 429 RATE (respeite o cabeçalho Retry-After), 429 COTA_DIARIA (teto do dia atingido), 404 NOT_FOUND (mostre "nada encontrado", não é cobrado).
Comece com a chave de teste (bk_test_…), que devolve dados fictícios e não gasta créditos.
Sim. A chave de teste (bk_test_…) é grátis, não expira com o sandbox e devolve dados fictícios no mesmo formato da produção — dá para montar a tela inteira sem gastar nada. Quando quiser dado real, ative o sandbox: 7 dias com 50 créditos reais, 10 requisições por minuto, 2 chaves e 1 webhook, uma vez por conta.
Ainda não cobrimos: o cadastro é municipal e entra cidade a cidade. Outras cidades chegam em breve — GET /v1/imovel/cidades sempre traz a lista atual.
Não. É o valor do cadastro da prefeitura, usado de base para impostos. Serve de referência para negociação e garantia, não substitui avaliação.