{"_id":"@brazil-visible/sdk","name":"@brazil-visible/sdk","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@brazil-visible/sdk","version":"0.1.0","description":"SDK TypeScript unificado para acesso a 93+ fontes de dados publicos brasileiros","type":"module","main":"./dist/index.cjs","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"require":{"types":"./dist/index.d.cts","default":"./dist/index.cjs"}}},"scripts":{"build":"tsup","dev":"tsup --watch","test":"vitest run","test:watch":"vitest","lint":"biome check src/ tests/","format":"biome check --write src/ tests/","typecheck":"tsc --noEmit"},"keywords":["brazil","dados-abertos","open-data","governo","transparencia","api","ibge","datasus","tse","receita-federal","sdk","typescript","dados-publicos","brazilian-government"],"author":{"name":"Brazil Visible","email":"contato@brazilvisible.org"},"license":"MIT","publishConfig":{"access":"public"},"sideEffects":true,"repository":{"type":"git","url":"git+https://github.com/lspassos1/brazil-visible-sdk.git"},"bugs":{"url":"https://github.com/lspassos1/brazil-visible-sdk/issues"},"homepage":"https://brazilvisible.org","engines":{"node":">=18"},"devDependencies":{"@biomejs/biome":"^1.9","@types/node":"^25.3.5","msw":"^2.7","tsup":"^8.0","typescript":"^5.5","vitest":"^3.0"},"dependencies":{"csv-parse":"^6.1.0"},"_id":"@brazil-visible/sdk@0.1.0","gitHead":"cb65ece420262f685931b5173f48e104f8849094","_nodeVersion":"18.20.8","_npmVersion":"10.8.2","dist":{"integrity":"sha512-EU/fV7Y7ijIuq+lQenG3/W8aHoc0VPt494TePGD+oo9lDlAoGZaZ6PMoBtpMzWKuNsi6eb7XOAZxJMycGR/5WA==","shasum":"69a692fc6e888fd93f4c96f6a4d87146022135ad","tarball":"https://registry.npmjs.org/@brazil-visible/sdk/-/sdk-0.1.0.tgz","fileCount":7,"unpackedSize":299151,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@brazil-visible%2fsdk@0.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIFpiVlA7a0bsuIFo2QqEEVaxe7UEmrPH4rCivNh4mBruAiEAsqPKgmKGmujHI30Ph0zCgk17zDmTs+pYDOt1wzdjTh0="}]},"_npmUser":{"name":"lspassos","email":"lspassos@icloud.com"},"directories":{},"maintainers":[{"name":"lspassos","email":"lspassos@icloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk_0.1.0_1773093712895_0.09305586228331197"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-09T22:01:52.796Z","0.1.0":"2026-03-09T22:01:53.049Z","modified":"2026-03-09T22:01:53.523Z"},"maintainers":[{"name":"lspassos","email":"lspassos@icloud.com"}],"description":"SDK TypeScript unificado para acesso a 93+ fontes de dados publicos brasileiros","homepage":"https://brazilvisible.org","keywords":["brazil","dados-abertos","open-data","governo","transparencia","api","ibge","datasus","tse","receita-federal","sdk","typescript","dados-publicos","brazilian-government"],"repository":{"type":"git","url":"git+https://github.com/lspassos1/brazil-visible-sdk.git"},"author":{"name":"Brazil Visible","email":"contato@brazilvisible.org"},"bugs":{"url":"https://github.com/lspassos1/brazil-visible-sdk/issues"},"license":"MIT","readme":"# Brazil Visible SDK\n\nSDK TypeScript unificado para acesso a **93+ fontes de dados publicos brasileiros**.\n\nUma interface programatica unica sobre APIs REST, downloads CSV, FTP e portais do governo federal — feito para jornalistas de dados, pesquisadores e desenvolvedores civicos.\n\n## Instalacao\n\n```bash\nnpm install @brazilvisible/sdk\n```\n\nCompativel com **Node.js >=18**, **Deno**, **Bun** e **browsers** (fontes REST).\n\n## Uso rapido\n\n```typescript\nimport { bcb, ibge } from \"@brazilvisible/sdk\";\n\nconst selic = await bcb.sgs({ serie: 11, inicio: \"2024-01-01\", fim: \"2024-12-31\" });\nconsole.log(selic);\n\nconst populacao = await ibge.agregados({ tabela: 1301, periodos: \"2022\", localidades: \"N1\" });\nconsole.log(populacao);\n```\n\n### Com autenticacao (CGU)\n\n```typescript\nimport { cgu, configure } from \"@brazilvisible/sdk\";\n\nconfigure({ apiKeys: { cgu: \"sua-chave-aqui\" } });\n\nconst contratos = await cgu.contratos({ orgao: \"25000\", ano: 2024 });\nconst sancionadas = await cgu.ceis();\n```\n\n### Download de dados (TSE, Receita, etc.)\n\n```typescript\nimport { tse, receita } from \"@brazilvisible/sdk\";\n\nconst candidatos = await tse.candidaturas({ ano: 2022, estado: \"SP\" });\nconsole.log(`${candidatos.length} candidaturas em SP`);\n\nconst empresas = await receita.empresas({ chunk: 0 });\n```\n\n### Cruzamento de dados\n\n```typescript\nimport { cgu } from \"@brazilvisible/sdk\";\n\nconst sancionadas = await cgu.ceis();\nconst contratos = await cgu.contratos({ ano: 2024 });\n\nconst cnpjsSancionados = new Set(sancionadas.map((s) => s.cnpj));\nconst irregulares = contratos.filter((c) => cnpjsSancionados.has(c.cnpj));\nconsole.log(`${irregulares.length} contratos com empresas sancionadas`);\n```\n\n## Fontes disponiveis (22 modulos, 97 metodos)\n\n### REST APIs\n\n| Modulo | Import | Metodos | Auth |\n|--------|--------|---------|------|\n| **BCB** | `bcb` | `sgs`, `expectativas`, `ifdata` | Nao |\n| **IBGE** | `ibge` | `estados`, `municipios`, `distritos`, `regioes`, `mesorregioes`, `microrregioes`, `agregados`, `agregadosMetadados`, `nomes`, `nomesRanking` | Nao |\n| **Tesouro** | `tesouro` | `entes`, `rreo`, `rgf` | Nao |\n| **IPEA** | `ipea` | `series`, `metadados` | Nao |\n| **CGU** | `cgu` | `ceis`, `cnep`, `cepim`, `ceaf`, `contratos`, `servidores`, `emendas`, `viagens` | API Key |\n| **Seguranca** | `seguranca` | `ocorrencias`, `indicadores` | Nao |\n| **Portais** | `portais` | `buscarConjuntos`, `recursos`, `baseDados`, `execucaoOrcamentaria` | Misto\\*\\* |\n| **Ambiente** | `ambiente` | `prodes`, `deter`, `focosCalor`, `ibamaMultas`, `car`, `unidadesConservacao`, `recursosHidricos` | Nao |\n| **Transportes** | `transportes` | `anacVoos`, `prfAcidentes`, `denatranFrota`, `dnit`, `antt` | Nao |\n| **Diarios** | `diarios` | `dou`, `doe` | Nao |\n| **Governamentais** | `governamentais` | `cadin`, `siorg`, `siape` | Misto\\*\\* |\n| **Outros** | `outros` | `ansOperadoras`, `antaqPortos`, `ancineProjetos` | Nao |\n| **CNJ** | `cnj` | `justicaNumeros`, `datajud`\\* | Varia |\n\n### Download CSV/ZIP\n\n| Modulo | Import | Metodos | Formato |\n|--------|--------|---------|---------|\n| **TSE** | `tse` | `candidaturas`, `bens`, `resultados`, `filiados`, `prestacaoContas`, `eleitorado`, `boletins` | ZIP/CSV |\n| **Receita** | `receita` | `empresas`, `estabelecimentos`, `socios`, `simples` | ZIP/CSV |\n| **Mercado/CVM** | `mercado` | `dfp`, `itr`, `ciasAbertas`, `fundos`, `cvmAdministradores`, `cvmFatosRelevantes`, `b3Cotacoes` | ZIP/CSV |\n| **INEP** | `inep` | `enem`, `censoEscolar`, `censoSuperior`, `fnde` | ZIP/CSV |\n| **Trabalho** | `trabalho` | `caged`, `rais` | ZIP/CSV |\n| **Previdencia** | `previdencia` | `beneficios`, `fundosPensao` | CSV |\n| **Reguladoras** | `reguladoras` | `anatelAcessos`, `aneelTarifas`, `anpCombustiveis`, `anvisaMedicamentos` | CSV |\n\n### Especializados\n\n| Modulo | Import | Metodos | Notas |\n|--------|--------|---------|-------|\n| **DATASUS** | `datasus` | `cnes`, `sim`, `sih`, `sinan`, `sinasc` | FTP/DBC — fallback informativo |\n| **Geo** | `geo` | `municipios`, `malha`, `wmsCapabilities`, `wmsGetMap`, `cprm`, `incra`, `inde`, `inpeSatelite` | WMS/WFS/GeoJSON |\n\n\\* `datajud` requer cadastro especial no CNJ — o metodo orienta sobre como obter acesso.\n\n\\*\\* `execucaoOrcamentaria` e `siape` utilizam a API do Portal da Transparencia e requerem API key da CGU.\n\n## Configuracao\n\n```typescript\nimport { configure } from \"@brazilvisible/sdk\";\n\nconfigure({\n  timeout: 60000,\n  maxRetries: 5,\n  apiKeys: {\n    cgu: \"sua-chave\",\n  },\n});\n```\n\n## Desenvolvimento\n\n```bash\ngit clone git@github.com:nferdica/brazil-visible-sdk.git\ncd brazil-visible-sdk\nnpm install\nnpm run build\nnpm test\nnpm run lint\nnpm run typecheck\n```\n\n## Projeto irmao\n\nEste SDK e a camada programatica do [Brazil Visible](https://brazilvisible.org) — catalogo de documentacao com 93+ fontes de dados publicos brasileiros.\n\n## Licenca\n\nMIT\n","readmeFilename":"README.md","_rev":"1-22f57ce1df7605666bb5196e61f36569"}