Documentação
Modelo de dados
Um kondo é um condomínio ou empreendimento — o conjunto, não um apartamento, casa ou lote. Os tipos e campos abaixo saem do mesmo contrato OpenAPI da referência. Campos sem valor na fonte vêm como null, nunca omitidos.
Resumo (busca)
Cada item de /v1/kondos e /v1/demo/kondos traz só estes campos (schema KondoSummary):
slugsempre presente- stringIdentificador estável do kondo; é o que vai em
/v1/kondos/{slug}. namesempre presente- stringNome do condomínio ou empreendimento, como a fonte o apresenta.
citysempre presente- string | nullCidade, por extenso (o filtro
cityusa o slug de/v1/cities). ufsempre presente- string | nullSigla do estado.
ACALAPAMBACEDFESe mais 19 neighborhoodsempre presente- string | nullBairro, como na fonte.
typesempre presente- string | nullTipo do kondo (tabela abaixo).
bairrocasaschacataspredioscomercialindustrial property_statussempre presente- string | nullFase do empreendimento (tabela abaixo).
launchingunder_constructionexistingunknown updated_atsempre presente- string (data e hora ISO 8601) | nullÚltima atualização do registro no catálogo.
Registro completo (ficha)
/v1/kondos/{slug} devolve o resumo e mais estes campos (schema KondoDetail):
address_streetsempre presente- string | nullLogradouro, quando a fonte publica.
cepsempre presente- string | nullCEP, quando conhecido.
latsempre presente- number | nullLatitude em graus decimais.
lngsempre presente- number | nullLongitude em graus decimais.
reference_pricesempre presente- number | nullPreço "a partir de" publicado na fonte, em R$. Não é avaliação nem preço de uma unidade.
price_collected_atsempre presente- string (data e hora ISO 8601) | nullÚltima leitura da fonte que encontrou o preço de referência, mesmo que igual.
condo_feesempre presente- number | nullTaxa de condomínio mensal publicada na fonte, em R$.
construction_yearsempre presente- integer | nullAno de construção do prédio, como a página de origem informa. Não é
registered_since(a abertura do CNPJ). buildersempre presente- objeto | nullConstrutora ou incorporadora:
{ name, url }. amenitiessempre presente- string[]Chaves de comodidade (lista abaixo, com os nomes em português).
mediasempre presente- string (URL)[]URLs originais das imagens, na fonte. Não hospedamos cópias.
provenancesempre presente- objetoDe onde veio o registro (próxima seção).
Procedência
Todo registro diz de onde veio, no bloco provenance, para você decidir se o dado serve para o seu uso e conferir na fonte.
source_urlsempre presente- string (URL) | nullPágina de onde os dados foram coletados.
source_typesempre presente- string | nullTipo da fonte: A marketplace, B construtora, C imobiliária, S site próprio do condomínio, R registro público (dataset aberto; sem página de origem).
ABCSR source_namesempre presente- string | nullNome da fonte (para R, o nome do dataset), quando conhecido.
registry_idsempre presente- string | nullIdentificador do condomínio num registro público (o CNPJ, só dígitos), quando conhecido.
registered_sincesempre presente- string | nullPara R: data em que o condomínio foi registrado (abertura do CNPJ). Não é a idade do prédio; prédios anteriores a ~1990 receberam o CNPJ depois de construídos.
collected_atsempre presente- string (data e hora ISO 8601) | nullQuando a página foi coletada.
data_updated_atsempre presente- string (data e hora ISO 8601) | nullÚltima mudança de qualquer campo do registro (o mesmo instante de
updated_at). confidencesempre presente- number | nullConfiança da extração, de 0 a 1. Só é publicado o que passou no controle de qualidade.
extraction_methodsempre presente- string | nullComo os campos foram extraídos da página:
llm(modelo de linguagem) oudeterministic(regras fixas).
Fase do empreendimento
property_status e o filtro de mesmo nome aceitam:
launching- Lançamento: à venda, obras ainda não começaram ou acabaram de começar.
under_construction- Em obras.
existing- Pronto: entregue e habitado.
unknown- A fonte não informa a fase.
Tipo
type e o filtro de mesmo nome aceitam:
bairro- Bairro planejado ou loteamento fechado.
casas- Condomínio de casas.
chacatas- Condomínio de chácaras (o valor é grafado assim na API).
predios- Condomínio de edifícios (apartamentos).
comercial- Empreendimento comercial.
industrial- Condomínio industrial ou logístico.
Comodidades
amenities traz chaves estáveis em inglês; o filtro amenity aceita as mesmas. Os nomes em português e quantos condomínios publicados têm cada uma vêm de /v1/amenities (sem chave, sem custo).
- Academia
gym1471 - Acessível para cadeirantes
wheelchair_accessible500 - Acesso a lago
lake_access6 - Acesso à praia
beach_access34 - Acesso por biometria
biometric_access67 - Adega
wine_cellar15 - Água encanada
water_supply649 - Área gramada
lawn_area38 - Biblioteca
library25 - Bicicletário
bike_parking670 - Bosque
woods121 - Brinquedoteca
toy_library592 - Calçadas
sidewalks41 - Câmeras de segurança
cctv122 - Campo de futebol
soccer_field72 - Captação de água da chuva
rainwater_harvesting38 - Carregador para carro elétrico
ev_charging105 - Cerca elétrica
electric_fence36 - Churrasqueira
barbecue_area1313 - Cinema
home_theater75 - Concierge
concierge40 - Coworking
coworking_space395 - Creche
daycare11 - Depósito privativo
storage_locker128 - Elevador
elevator499 - Energia elétrica
electricity182 - Equipe de segurança
security_team1039 - Espaço de convivência
social_area286 - Espaço gourmet
gourmet_area854 - Espaço kids
kids_area506 - Espaço pet
pet_area849 - Espaço teen
teen_area87 - Estacionamento
parking_lot1206 - Fire pit
fire_pit64 - Fraldário
baby_care_room28 - Geração própria de energia
own_power_generation89 - Guarita
gated_entrance718 - Heliporto
heliport9 - Hidromassagem
hot_tub44 - Home office
home_office142 - Horta
vegetable_garden194 - Interfone
intercom25 - Internet banda larga
internet117 - Jardins
gardens670 - Lagoa
lagoon66 - Lava-rápido
car_wash36 - Lavanderia compartilhada
laundry_room162 - Lounge bar
lounge_bar361 - Manobrista
valet_parking5 - Mercado próximo
market_nearby349 - Muro de segurança
perimeter_wall331 - Pet wash
pet_washing_station108 - Piscina
pool1462 - Piscina aquecida
heated_pool96 - Piscina coberta
indoor_pool89 - Pista de cooper
running_track59 - Placas solares
solar_panels54 - Playground
playground1216 - Portaria 24h
lobby_24h195 - Portaria virtual
virtual_concierge22 - Quadra de squash
squash_court13 - Quadra de tênis
tennis_court105 - Quadra poliesportiva
sports_court869 - Rampa de acesso
ramp_access11 - Restaurante
restaurant37 - Reúso de água cinza
greywater_reuse13 - Rooftop
rooftop416 - Sala de encomendas
package_room88 - Sala de karaokê
karaoke_room0 - Sala de música
music_room6 - Sala de reuniões
meeting_room43 - Sala de sinuca
billiards_room3 - Sala de yoga
yoga_room152 - Salão de festas
party_room1463 - Salão de jogos
game_room534 - Sauna
sauna301 - Sauna a vapor
steam_room50 - Sistema de alarme
alarm_system11 - Solário
solarium249 - Spa
spa208 - Telhado verde
green_roof1 - Trilha
nature_trail40 - Vagas para motos
motorcycle_parking50 - Vagas para visitantes
visitor_parking53
O que é servido
- Só condomínios publicados: os que passaram no controle de qualidade do catálogo. Rascunhos e arquivados não aparecem, e um
slugnão publicado responde 404, igual a um que não existe. Por isso a resposta não tem campostatus. - Mídia é a URL original de cada imagem, na fonte. Não servimos cópias; uma imagem pode sair do ar se a fonte a remover.
- Unidades e lotes ainda não estão na API. Hoje o catálogo descreve o condomínio; unidades à venda e lotes virão depois, em campos novos dentro de
/v1, anunciados no changelog.