search_projects
Buscar empreendimentos
Busca empreendimentos publicados na ObraAberta por texto, cidade, estado, status, faixa de preço, dormitórios e amenidades. Somente dados públicos.
输入参数qcitypagesortlimitorderstatestatusbedroomsamenitiesmax_pricemin_price
get_project
Ficha pública do empreendimento
Consulta a ficha pública de um empreendimento da ObraAberta por slug ou UUID, com linha do tempo resumida e avaliações moderadas.
输入参数id必填
find_projects_nearby
Empreendimentos por raio
Lista empreendimentos publicados dentro de um raio a partir de uma latitude e longitude. Somente obras com coordenada registrada.
输入参数citypagelimitstatestatuslatitude必填longitude必填radius_km
get_project_timeline
Linha do tempo pública
Consulta a linha do tempo pública de um empreendimento: etapas, percentuais e evidências já aprovadas na moderação.
输入参数id必填order
get_project_ratings
Avaliações públicas
Consulta o resumo e as avaliações públicas já moderadas de um empreendimento. Nenhum dado pessoal do autor é retornado.
输入参数id必填pagelimit
get_project_nearby_services
Serviços próximos (OpenStreetMap)
Lista escolas, hospitais, transporte e comércio próximos a um empreendimento, a partir do OpenStreetMap. Exige atribuição ODbL na exibição.
输入参数id必填typesradius_km
list_builders
Listar construtoras
Lista construtoras e incorporadoras do diretório público da ObraAberta. Não retorna dados cadastrais internos nem contatos pessoais.
输入参数qpagesortlimitorderstate
get_builder
Ficha pública da construtora
Consulta a ficha pública de uma construtora e os indicadores públicos disponíveis, por slug ou UUID.
输入参数id必填
get_builder_projects
Empreendimentos de uma construtora
Lista os empreendimentos publicados vinculados a uma construtora do diretório público da ObraAberta.
输入参数id必填citypagelimitstatestatus
get_public_sources
Fontes públicas e limitações
Lista as fontes públicas usadas pela ObraAberta, com a natureza de cada uma (oficial, pública, colaborativa, OpenStreetMap) e suas limitações.
无需输入参数。
health
Disponibilidade da API pública
Verifica se a API pública da ObraAberta está disponível e qual versão responde.
无需输入参数。