The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.

transfRgov - Pacote de Acesso a APIs do TransfereGov

Rodrigo E. S. Borges 2026-09-20

transfRgov

codecov

Introdução

O transfRgov é um pacote em R que facilita o acesso aos dados disponíveis na API Fundo a Fundo (TransfereGov). O pacote monta as consultas aos diferentes endpoints da API no padrão PostgREST por meio de um helper interno, sem depender de pacotes externos de acesso ao PostgREST. Cada endpoint é acessado por uma função cujo nome inicia com ler_ ou get_, permitindo filtrar os resultados pelos próprios nomes das colunas da API no formato nome_parametro = valor (traduzido para nome_parametro=eq.valor na requisição HTTP interna).

O pacote também baixa dados abertos do Portal da Transparência e do Tesouro Transparente, como os arquivos mensais de transferências para municípios, a tabela de correspondência entre códigos SIAFI e IBGE e os registros de renúncias fiscais.

Instalação

A versão de desenvolvimento pode ser instalada pelo GitHub:

# Instale o transfRgov a partir do GitHub
devtools::install_github("DistintiveLab/transfRgov")

Após a publicação no CRAN, o pacote poderá ser instalado com:

install.packages("transfRgov")

Uso

Carregue o pacote e utilize as funções para acessar os dados dos diversos endpoints da API.

Exemplos

Ler dados do endpoint programa

library(transfRgov)

# Exemplo: Ler dados de programas filtrando pelo ano 2020 e modalidade "Ordinário"
dados_programa <- ler_programas(ano_programa = 2020, modalidade_programa = "Ordinário")
head(dados_programa)

Ler dados do endpoint empenho

# Exemplo: Ler empenhos do ano de 2020 para um determinado plano de ação
dados_empenho <- ler_empenho(ano_empenho = 2020, id_plano_acao = 1234)
head(dados_empenho)

Ler dados do endpoint relatorio_gestao

# Exemplo: Ler relatórios de gestão para um plano de ação específico
dados_relatorio <- ler_relatorio_gestao(id_plano_acao = 1234)
head(dados_relatorio)

Baixar transferências mensais da União

# Exemplo: Baixar as transferências de janeiro de 2023 e acrescentar o código IBGE
transferencias <- download_transferencias_uniao(ano = 2023, mes = 1)
head(transferencias)

Endpoints Disponíveis

As funções de leitura da API Fundo a Fundo são:

Dados e utilitários

Dados de Resposta

Cada função retorna os dados da API Fundo a Fundo como uma lista ou data frame, contendo as colunas especificadas pela documentação da API. Estes dados podem ser manipulados e analisados diretamente no R.

Contribuição

Contribuições são bem-vindas! Envie issues e pull requests para melhorar o pacote.

Licença

Este pacote é distribuído sob a Licença MIT.

Disclaimer - Nota de isenção de responsabilidade:

Este pacote não é uma ferramenta oficial do Ministério da Gestão ou de qualquer órgão do governo federal. Ele foi desenvolvido de forma voluntária e independente, sem qualquer vínculo, afiliação ou endosso por parte de autoridades governamentais. Os desenvolvedores não assumem responsabilidade por alterações na API Fundo a Fundo, eventuais inconsistências ou interrupções na disponibilidade dos dados.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.