Brazil Visible SDK

SDK TypeScript unificado para acesso a 93+ fontes de dados publicos brasileiros.

Uma interface programatica unica sobre APIs REST, downloads CSV, FTP e portais do governo federal — feito para jornalistas de dados, pesquisadores e desenvolvedores civicos.

Instalacao

npm install @brazilvisible/sdk

Compativel com Node.js >=18, Deno, Bun e browsers (fontes REST).

Uso rapido

import { bcb, ibge } from "@brazilvisible/sdk";

const selic = await bcb.sgs({ serie: 11, inicio: "2024-01-01", fim: "2024-12-31" });
console.log(selic);

const populacao = await ibge.agregados({ tabela: 1301, periodos: "2022", localidades: "N1" });
console.log(populacao);

Com autenticacao (CGU)

import { cgu, configure } from "@brazilvisible/sdk";

configure({ apiKeys: { cgu: "sua-chave-aqui" } });

const contratos = await cgu.contratos({ orgao: "25000", ano: 2024 });
const sancionadas = await cgu.ceis();

Download de dados (TSE, Receita, etc.)

import { tse, receita } from "@brazilvisible/sdk";

const candidatos = await tse.candidaturas({ ano: 2022, estado: "SP" });
console.log(`${candidatos.length} candidaturas em SP`);

const empresas = await receita.empresas({ chunk: 0 });

Cruzamento de dados

import { cgu } from "@brazilvisible/sdk";

const sancionadas = await cgu.ceis();
const contratos = await cgu.contratos({ ano: 2024 });

const cnpjsSancionados = new Set(sancionadas.map((s) => s.cnpj));
const irregulares = contratos.filter((c) => cnpjsSancionados.has(c.cnpj));
console.log(`${irregulares.length} contratos com empresas sancionadas`);

Fontes disponiveis (22 modulos, 97 metodos)

REST APIs

Modulo	Import	Metodos	Auth
BCB	bcb	sgs, expectativas, ifdata	Nao
IBGE	ibge	estados, municipios, distritos, regioes, mesorregioes, microrregioes, agregados, agregadosMetadados, nomes, nomesRanking	Nao
Tesouro	tesouro	entes, rreo, rgf	Nao
IPEA	ipea	series, metadados	Nao
CGU	cgu	ceis, cnep, cepim, ceaf, contratos, servidores, emendas, viagens	API Key
Seguranca	seguranca	ocorrencias, indicadores	Nao
Portais	portais	buscarConjuntos, recursos, baseDados, execucaoOrcamentaria	Misto**
Ambiente	ambiente	prodes, deter, focosCalor, ibamaMultas, car, unidadesConservacao, recursosHidricos	Nao
Transportes	transportes	anacVoos, prfAcidentes, denatranFrota, dnit, antt	Nao
Diarios	diarios	dou, doe	Nao
Governamentais	governamentais	cadin, siorg, siape	Misto**
Outros	outros	ansOperadoras, antaqPortos, ancineProjetos	Nao
CNJ	cnj	justicaNumeros, datajud*	Varia

Download CSV/ZIP

Modulo	Import	Metodos	Formato
TSE	tse	candidaturas, bens, resultados, filiados, prestacaoContas, eleitorado, boletins	ZIP/CSV
Receita	receita	empresas, estabelecimentos, socios, simples	ZIP/CSV
Mercado/CVM	mercado	dfp, itr, ciasAbertas, fundos, cvmAdministradores, cvmFatosRelevantes, b3Cotacoes	ZIP/CSV
INEP	inep	enem, censoEscolar, censoSuperior, fnde	ZIP/CSV
Trabalho	trabalho	caged, rais	ZIP/CSV
Previdencia	previdencia	beneficios, fundosPensao	CSV
Reguladoras	reguladoras	anatelAcessos, aneelTarifas, anpCombustiveis, anvisaMedicamentos	CSV

Especializados

Modulo	Import	Metodos	Notas
DATASUS	datasus	cnes, sim, sih, sinan, sinasc	FTP/DBC — fallback informativo
Geo	geo	municipios, malha, wmsCapabilities, wmsGetMap, cprm, incra, inde, inpeSatelite	WMS/WFS/GeoJSON

* datajud requer cadastro especial no CNJ — o metodo orienta sobre como obter acesso.

** execucaoOrcamentaria e siape utilizam a API do Portal da Transparencia e requerem API key da CGU.

Configuracao

import { configure } from "@brazilvisible/sdk";

configure({
  timeout: 60000,
  maxRetries: 5,
  apiKeys: {
    cgu: "sua-chave",
  },
});

Desenvolvimento

git clone git@github.com:nferdica/brazil-visible-sdk.git
cd brazil-visible-sdk
npm install
npm run build
npm test
npm run lint
npm run typecheck

Projeto irmao

Este SDK e a camada programatica do Brazil Visible — catalogo de documentacao com 93+ fontes de dados publicos brasileiros.

Licenca

MIT