Dados Abertos
Consulta pública da API: endereços, o que cada um devolve e como ler a resposta.
Como consultar
As leituras são públicas. Use GET, sem autenticação. A base é https://api.olhodaguadasflores.online/api/v1. Datas vêm em ISO-8601 e valores em reais, como número.
A lista aceita page (padrão 1) e pageSize (padrão 20, máximo 100). Os filtros da tela entram na query com o nome do campo.
{
"success": true,
"data": [],
"meta": {
"pagination": {
"page": 1,
"pageSize": 20,
"total": 0,
"totalPages": 0,
"hasNextPage": false,
"hasPreviousPage": false
},
"atualizadoEm": null
}
}O detalhe devolve { "success": true, "data": { } }. Se a consulta falhar, a resposta é { "success": false, "error": { "code", "message" } }.
O estado da API responde em https://api.olhodaguadasflores.online/health com { "status": "ok" }.
Licitações e contratos
| Endpoint | Consulta | Retorno de data |
|---|---|---|
GET /api/v1/licitacoes | Lista as licitações publicadas. | Lista paginada. Cada item: id, numeroLicitacao, numeroProcesso, titulo, objeto, tipo, modalidade, status, dataPublicacao, dataInicio, dataFim, valor, idOrgao. |
GET /api/v1/licitacoes/:id | Detalhe de uma licitação, com órgão, anexos, empenhos, fornecedores e contratos. | Objeto: os campos da lista, mais historicoEtapas, orgao, anexos, empenhos, fornecedores e contratos. |
GET /api/v1/licitacoes/opcoes | Lista enxuta para seleção. | Lista de { id, numeroLicitacao }. |
GET /api/v1/contratos | Lista os contratos. | Lista paginada. Cada item: id, numero, objeto, tipo, valor, dataInicio, dataFim, dataPublicacao, idOrgao, idFornecedor, idLicitacao. |
GET /api/v1/contratos/:id | Detalhe de um contrato. | Objeto: os mesmos campos da lista. |
GET /api/v1/aditivos-contratos | Lista os aditivos de contrato. | Lista paginada. Cada item: id, numero, objeto, valor, dataInicio, dataFim, dataPublicacao, idContrato, contrato. |
GET /api/v1/aditivos-contratos/:id | Detalhe de um aditivo. | Objeto: os mesmos campos da lista. |
GET /api/v1/fiscais-contratos | Lista os fiscais de contrato. | Lista paginada. Cada item: id, nome, email, cpf, contratos. |
GET /api/v1/fiscais-contratos/:id | Detalhe de um fiscal. | Objeto: os mesmos campos da lista. |
GET /api/v1/fornecedores | Lista os fornecedores. | Lista paginada. Cada item: id, nomeFantasia, razaoSocial, cnpj, endereco, cidade, estado, cep, telefone, email. |
GET /api/v1/fornecedores/:id | Detalhe de um fornecedor. | Objeto: os mesmos campos da lista. |
GET /api/v1/empenhos | Lista os empenhos, com credor e licitação quando houver vínculo. | Lista paginada. Cada item: id, numero, tipo, acao, fonteRecurso, despesa, modalidadeLicitacao, numeroProcesso, dataProcesso, numeroContrato, dataContrato, numeroConvenio, unidadeOrcamentaria, elementoDespesa, data, valorEmpenhado, valorLiquidado, valorPago, valorAPagar, idLicitacao, idFornecedor, idOrgao, idsContratos, fornecedor { id, razaoSocial, cnpj }, licitacao { id, numeroLicitacao }. |
GET /api/v1/empenhos/:id | Detalhe de um empenho, com as liquidações e os pagamentos que o compõem. | Objeto: os mesmos campos da lista, mais liquidacoes e pagamentos. |
GET /api/v1/liquidacoes | Lista as liquidações de empenho. Filtros: idEmpenho, exercicio, q (número). | Lista paginada. Cada item: id, numero, data, valor, idEmpenho. |
GET /api/v1/liquidacoes/:id | Detalhe de uma liquidação. | Objeto: os mesmos campos da lista. |
GET /api/v1/pagamentos | Lista os pagamentos de empenho. Filtros: idEmpenho, idLiquidacao, exercicio, q (número). | Lista paginada. Cada item: id, numero, dataPagamento, valor, banco, agencia, conta, tipoConta, idEmpenho, idLiquidacao. |
GET /api/v1/pagamentos/:id | Detalhe de um pagamento. | Objeto: os mesmos campos da lista. |
Convênios, transferências e obras
| Endpoint | Consulta | Retorno de data |
|---|---|---|
GET /api/v1/convenios | Lista os convênios e acordos. | Lista paginada. Cada item: id, numero, ano, concedente, convenente, objeto, descricao, situacao, tipoConvenio, tipoContratoConvenio, vigenciaInicio, vigenciaFim, statusVigencia, valorPrevisto, valorRepassado, valorContrapartida, totalTransferido. |
GET /api/v1/convenios/:id | Detalhe do convênio, com anexos e transferências. | Objeto: os campos da lista, mais anexos e transferencias (id, numero, dataTransferencia, descricao, valor, numeroOrdemPagamento, situacaoPagamento). |
GET /api/v1/transferencias | Lista as transferências. | Lista paginada. Cada item: id, numero, dataTransferencia, descricao, valor, numeroOrdemPagamento, situacaoPagamento, idConvenio. |
GET /api/v1/transferencias/:id | Detalhe de uma transferência. | Objeto: os mesmos campos da lista. |
GET /api/v1/obras | Lista as obras com o resumo financeiro. | Lista paginada. Cada item: id, situacao, dataInicio, previsaoConclusao, idLicitacao, licitacao, empresas, resumo (valorContratado, valorMedido, valorPago, valorPagoAcumulado, saldoRestante, porcentagemExecucao, executadoAtual, executadoAcumulado). |
GET /api/v1/obras/:id | Detalhe da obra, com contratos, itens, medições e anexos. | Objeto: os campos da lista, mais contratos, medidas (com itens), itensContrato (quantidade, precoUnitario, valorTotal, quantidadeExecutada, valorPago) e anexos. |
GET /api/v1/medidas-obras | Lista as medições de obra. | Lista paginada. Cada item: id, numero, periodoInicio, periodoFim, situacao, valor, porcentagemExecucao, idObra, idContrato. |
GET /api/v1/medidas-obras/:id | Detalhe de uma medição. | Objeto: os mesmos campos da lista. |
GET /api/v1/itens-contratos-obras | Lista os itens contratados das obras (quantitativos e preços unitários). | Lista paginada. Cada item: id, ordem, codigo, descricao, unidade, quantidade, precoUnitario, valorTotal, idObra, idContrato. |
GET /api/v1/itens-contratos-obras/:id | Detalhe de um item contratado. | Objeto: os mesmos campos da lista. |
GET /api/v1/itens-medidas-obras | Lista os quantitativos executados por item em cada medição. | Lista paginada. Cada item: id, quantidade, valor, idMedidaObra, idItemContratoObra. |
GET /api/v1/itens-medidas-obras/:id | Detalhe de um quantitativo de medição. | Objeto: os mesmos campos da lista. |
Servidores
| Endpoint | Consulta | Retorno de data |
|---|---|---|
GET /api/v1/servidores | Lista os servidores. | Lista paginada. Cada item: id, nome, cpf, matricula, portaria, dataAdmissao, dataExoneracao, dataInativacao, idOrgao, cargo, vinculo, nivel, cargaHoraria, urlContrato, urlFoto. |
GET /api/v1/servidores/:id | Detalhe de um servidor. | Objeto: os mesmos campos da lista. |
GET /api/v1/salarios | Lista a folha de pagamento. | Lista paginada. Cada item: id, competencia, dataPagamento, valorBruto, valorLiquido, descontos, idServidor. |
GET /api/v1/salarios/:id | Detalhe de um lançamento da folha. | Objeto: os mesmos campos da lista. |
GET /api/v1/cargos-servidores | Lista o padrão remuneratório. | Lista paginada. Cada item: id, cargo, tipo, padrao, salario, legislacao. |
GET /api/v1/cargos-servidores/:id | Detalhe de um cargo. | Objeto: os mesmos campos da lista. |
Publicações e planejamento
| Endpoint | Consulta | Retorno de data |
|---|---|---|
GET /api/v1/atos-normativos | Lista leis, decretos, portarias e outras publicações. | Lista paginada. Cada item: id, numero, tipo, titulo, descricao, dataPublicacao, assuntoNome, vigenciaInicio, vigenciaFim, urlAnexo. |
GET /api/v1/atos-normativos/:id | Detalhe de um ato normativo. | Objeto: os mesmos campos da lista. |
GET /api/v1/relatorios | Lista os relatórios de prestação de contas. | Lista paginada. Cada item: id, titulo, ano, tipo, descricao, dataPublicacao, periodoInicio, periodoFim, tipoPeriodo, idOrgao, orgao, urlAnexo. |
GET /api/v1/relatorios/:id | Detalhe de um relatório. | Objeto: os mesmos campos da lista. |
GET /api/v1/planos-contratacao-anuais | Lista os planos de contratação anual. | Lista paginada. Cada item: id, ano, descricao, status, urlAnexo. |
GET /api/v1/planos-contratacao-anuais/:id | Detalhe de um plano. | Objeto: os mesmos campos da lista. |
GET /api/v1/quadros-detalhamento-despesa | Lista os quadros de detalhamento da despesa. | Lista paginada. Cada item: id, exercicio, dataPublicacao, descricao, urlAnexo, idLoa, loa. |
GET /api/v1/quadros-detalhamento-despesa/:id | Detalhe de um quadro. | Objeto: os mesmos campos da lista. |
GET /api/v1/anexos | Lista os arquivos publicados. | Lista paginada. Cada item: id, descricao, tipo, fase, url, nomeOriginal, contentType, tamanhoBytes, origem, idOrigem. |
GET /api/v1/anexos/:id | Detalhe de um anexo. | Objeto: os mesmos campos da lista. |
GET /api/v1/orgaos | Lista as unidades administrativas. | Lista paginada. Cada item: id, nome, sigla, endereco, numero, telefone, email, horarioAtendimento, competencia, responsavel, cargoResponsavel. |
GET /api/v1/orgaos/:id | Detalhe de uma unidade, com organograma. | Objeto: os campos da lista, mais natureza, categoria, competencias e organograma. |
GET /api/v1/orgaos/opcoes | Lista enxuta para seleção. | Lista de { id, nome }. |
Execução orçamentária e atendimento
| Endpoint | Consulta | Retorno de data |
|---|---|---|
GET /api/v1/receitas | Lista a receita prevista e arrecadada por classificação. | Lista paginada. Cada item: id, exercicio, mes, natureza, categoriaEconomica, origem, especie, desdobramento, descricao, previsaoInicial, previsaoAtualizada, arrecadacao. |
GET /api/v1/receitas-arrecadadas | Lista os lançamentos de receita arrecadada. | Lista paginada. Cada item: id, lancamento, receita, fonteRecurso, data, documento, valor. |
GET /api/v1/outras-receitas | Lista outras receitas (extraorçamentárias e transferências). | Lista paginada. Cada item: id, codigo, descricao, data, valor, tipo. |
GET /api/v1/despesas-orcamentarias | Lista a despesa por classificação (órgão, unidade, função, subfunção, programa, ação, fonte, fornecedor…). Filtros: exercicio, mes (0=consolidado), tipo, codigo, q. meta.totais soma valor, empenhado, liquidado e pago. | Lista paginada. Cada item: id, codigo, tipo (ACAO|ELEMENTO|FONTE_RECURSO|FORNECEDOR|FUNCAO|ORGAO|PROGRAMA|SUBFUNCAO|UNIDADE), exercicio, mes, data, descricao, cpfCnpj, razaoSocial, valor, empenhado, liquidado, pago. |
GET /api/v1/despesas-orcamentarias/:id | Detalhe de um registro de despesa orçamentária. | Objeto: os mesmos campos da lista. |
GET /api/v1/despesas-naturezas | Lista a despesa por natureza → elemento → subelemento. Filtros: exercicio, mes (0=consolidado), natureza, elemento, q. meta.totais soma empenhado, liquidado e pago. | Lista paginada. Cada item: id, exercicio, mes, natureza, descricaoNatureza, elemento, descricaoElemento, subelemento, descricaoSubelemento, empenhado, liquidado, pago. |
GET /api/v1/despesas-naturezas/:id | Detalhe de um registro de despesa por natureza. | Objeto: os mesmos campos da lista. |
GET /api/v1/dividas-ativas | Lista os inscritos em dívida ativa. | Lista paginada. Cada item: id, exercicio, nomeInscrito, valorTotal, dataInscricao. |
GET /api/v1/empenhos | Lista os empenhos. Filtros: exercicio, mes, q (número, credor, licitação, ação ou processo), fonteRecurso, modalidadeLicitacao, idLicitacao, idContrato, idFornecedor, idOrgao. | Lista paginada. Cada item: id, numero, tipo, acao, fonteRecurso, despesa, modalidadeLicitacao, numeroProcesso, dataProcesso, numeroContrato, dataContrato, numeroConvenio, unidadeOrcamentaria, elementoDespesa, data, valorEmpenhado, valorLiquidado, valorPago, valorAPagar, idLicitacao, idFornecedor, idOrgao, idsContratos, fornecedor { id, razaoSocial, cnpj }, licitacao { id, numeroLicitacao }. |
GET /api/v1/busca?q= | Busca em licitações, contratos, receitas, despesas, dívida ativa, empenhos e servidores. | Lista de { tipo, titulo, descricao, href }. |
GET /api/v1/movimentos-financeiros?tipo=DIARIA | Lista diárias importadas da planilha. tipo=DESPESA lista a relação de despesas. pagos=1 restringe aos pagamentos. | Lista paginada. Cada item: id, numero, tipo, documentoCredor, nomeCredor, numeroProcesso, data, historico, valor, valorLiquidado, valorPago, valorAPagar. |
GET /api/v1/registros-complementares?tipo=CONCURSO | Lista concursos, terceirizados, sanções, renúncias, emendas, tabela de diárias, regulamento, encarregado de dados, norma da LAI, informações classificadas e desclassificadas. | Lista paginada. Cada item: id, tipo, titulo, complemento, descricao, documento, exercicio, valor, dataReferencia, dataFim, url. |
GET /api/v1/manifestacoes/estatisticas?tipo=SIC&ano=2026 | Totais anuais do SIC (ou Ouvidoria): recebidos, atendidos, indeferidos e abertos, sem dados pessoais. | Objeto: tipo, ano, recebidos, atendidos, indeferidos, abertos. |
GET /api/v1/manifestacoes/protocolo/:protocolo | Consulta pública de uma manifestação pelo protocolo. | Objeto: id, protocolo, tipo, nome, email, mensagem, situacao, resposta, respondidaEm, createdAt. |
Saúde e educação
| Endpoint | Consulta | Retorno de data |
|---|---|---|
GET /api/v1/documentos-saude | Lista o plano de saúde, a programação anual e o relatório de gestão. Filtros: tipo (PLANO_SAUDE, PROGRAMACAO_ANUAL, RELATORIO_GESTAO), exercicio, q. | Lista paginada. Cada item: id, tipo, titulo, exercicio, exercicioFinal, descricao, dataPublicacao, url. |
GET /api/v1/servicos-saude | Lista os serviços de saúde, com local, profissional, especialidade e horário. Filtros: unidade, especialidade, q. | Lista paginada. Cada item: id, unidade, endereco, telefone, especialidade, profissional, registroProfissional, diasAtendimento, horarioInicio, horarioFim. |
GET /api/v1/estoques-medicamentos | Lista o estoque de medicamentos das farmácias públicas na posição mais recente de cada farmácia. Filtros: farmacia, medicamento. | Lista paginada. Cada item: id, farmacia, medicamento, apresentacao, unidadeMedida, quantidade, dataPosicao. |
GET /api/v1/lista-espera-creche | Lista a espera em creches públicas, identificada por protocolo. Filtros: creche, etapa, situacao, protocolo. | Lista paginada. Cada item: id, creche, etapa, posicao, protocolo, dataInscricao, pontuacao, situacao. |
GET /api/v1/criterios-priorizacao-creche | Lista os critérios de priorização de acesso às creches. Filtro: q. | Lista paginada. Cada item: id, ordem, criterio, descricao, pontuacao, fundamentoLegal. |