Bem vindo a página da API de dados abertos.
Nesta página estará disponível o acesso as informações de receitas, despesas, licitações, contratos e termos aditivos da entidade acessível por meio da nossa API de dados abertos, bem como os exemplos de como consumir esses dados e a utilização de filtros específicos.
A API é uma ferramenta específica para usuários técnicos que desejam obter dados sem navegar pelo Portal da Transparência. Através da API, usuários podem desenvolver programas que se conectam diretamente às máquinas do Portal da Transparência e selecionam os dados desejados. Esses dados são os mesmos obtidos em tela, ou seja, os dados obtidos via API podem também ser obtidos via consultas em tela pelos usuários não técnicos.
Em uma analogia com o mundo real, a API pode ser vista como um carro sem motorista. O carro está lá com todos os recursos disponíveis e um manual que ensina como ele deve ser utilizado. Seguindo as instruções, você pode ir para onde quiser (no caso de dados, pedir os dados que quiser). O uso do Portal sem API seria como um motorista de aplicativo ou um taxi. Nesse carro, o motorista se apresenta e você fala o caminho que quer ir (o dado que quer obter). É o motorista (no caso, o site), o responsável por guiar o carro e te levar ao local desejado (fornecer o dado).
Em outra analogia, a API pode ser vista como um quadro em branco com as tintas, pincéis e materiais necessários para fazer qualquer pintura. A navegação pelo site, ou seja, sem o uso da API, seria uma exposição de quadros onde existem quadros prontos dos melhores pintores. Você escolhe a pintura ou as pinturas que mais agradam. Com a vantagem de que, no Portal da Transparência, você não paga nada pelas diversas formas de visualização dos dados oferecidas.
Retorna uma lista de dados referente as transferências recebidas pela entidade, filtrada por {ano}
que a transferência foi recebida.
https://transparencia.vertentes.pe.leg.br/api/receitas/transferencia/2023/
- {
- ano: "2023",
- mes: "01",
- tipo_transferencia: "Outros Repasses Financeiros",
- fonte: "Recursos do Exercício Corrente / Recursos não Vinculados de Impostos / -",
- valor: "2609.54",
- ug_transf_nome: "Nome da entidade que transferiu",
- }
Retorna uma lista de dados referente as despesas empenhadas pela entidade, filtrada por {ano}
que a despesa foi empenhada.
https://transparencia.vertentes.pe.leg.br/api/despesas/empenho/2023/
- {
- ano_emissao_emp: "2023",
- n_emp: "0000001",
- data_emissao: "03/01/2023",
- valor: "100,00",
- tipo_empenho: "Estimativo",
- hist_emp: "Histórico do empenho",
- fornecedor: "Nome ou razão do fornecedor",
- denom_uni_orc: "Secretaria",
- funcao: "Administração",
- sub_funcao: "Administração Geral",
- programa: "Administração Geral",
- acao: "GESTÃO TÉCNICA E ADMINISTRATIVA DA SECRETARIA",
- ident_acao: "Atividade",
- cat_econ: "Despesa Corrente",
- natureza_despesa: "Outras Despesas Correntes",
- modalidade_despesa: "Aplicações Diretas",
- elemento_despesa: "Despesas de Exercícios Anteriores",
- sub_elem_desp: "SEM SUBELEMENTO",
- fonte_recurso: "Recursos do Exercício Corrente / Recursos não Vinculados de Impostos / -",
- }
Retorna uma lista de dados referente as licitações da entidade, filtrada por {ano}
que a licitação foi aberta.
https://transparencia.vertentes.pe.leg.br/api/licitacoes/2023/
- {
- status: "Homologada",
- numero: "001/2023",
- modalidade: "Pregão eletrônico",
- procedimento: "001/2023",
- data_abertura: "01/02/2023",
- data_homologacao: "17/02/2023",
- objeto: "Objeto do processo licitatório",
- favorecido: "Nome ou razão do favorecido",
- valor: "30.000,00",
- participantes: "Nome ou razão dos partcipantes",
- }
Retorna uma lista de dados referente os contratos da entidade, filtrada por {ano}
que o contrato foi realizado.
https://transparencia.vertentes.pe.leg.br/api/contratos/2023/
- {
- status: "Homologada",
- numero: "001/2023",
- modalidade: "Pregão eletrônico",
- procedimento: "001/2023",
- data_abertura: "01/02/2023",
- data_homologacao: "17/02/2023",
- objeto: "Objeto do processo licitatório",
- favorecido: "Nome ou razão do favorecido",
- valor: "30.000,00",
- participantes: "Nome ou razão dos partcipantes",
- }