❤
npm
Sign UpSign In

dadosabertos-js

0.0.5 • Public • Published

Install

npm install dadosabertos-js

Documentation

Setting Up

const dadosabertos = require("dadosabertos-js");

Use:

DadosAbertos.blocos().then((data) => console.log(data));

Data API

https://dadosabertos.camara.leg.br/ API wrapper

blocos({ id, idLegislatura, pagina, itens, ordem, ordenarPor }): Lista de dados sobre os blocos partidários
Argument Type Value Required
id array[Int] Número(s) identificador(es) de um ou mais bloco(s), separados por vírgulas. false
idLegislatura array[Int] Número(s) identificador(es) de uma ou mais legislatura(s), separados por vírgulas. false
pagina Int Número da página de resultados. Default = 1 false
itens Int Número máximo de itens na página que se deseja obter com esta requisição. Default = 10 false
ordem String O sentido da ordenação: asc para A a Z ou 0 a 9, e desc para Z a A ou 9 a 0. Default = ASC false
ordenarPor String Nome do campo pelo qual a lista será ordenada: idLegislatura, id ou nome. Default = ID false 
DadosAbertos.blocos({ id: [1], idLegislatura: [1] })
  .then((data) => console.log(data))
  .catch(err) => console.log(err);
blocosById(id): Informações sobre um bloco partidário específico
Argument Type Value Required
id Int Número identificador do bloco de partidos. true 
DadosAbertos.blocosById(1)
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

deputados({ id, nome, idLegislatura, siglaUf, siglaPartido, siglaSexo, dataInicio, dataFim, pagina, itens, ordem, ordenarPor }): Listagem e busca de deputados, segundo critérios

Argument Type Value Required
id array[Int] Número(s) identificador(es) de um deputado, separados por vírgulas. false
nome String Parte nome parlamentar. false
idLegislatura array[Int] Número(s) identificador(es) de uma ou mais legislatura(s), separados por vírgulas. false
siglaUf array[String] Uma ou mais sigla(s) de unidades federativas (estados e Distrito Federal). false
siglaPartido array[String] Uma ou mais sigla(s) de partidos aos quais sejam filiados os deputados. false
siglaSexo String Letra que designe o gênero dos parlamentares que se deseja buscar, sendo M para masculino e F para feminino false
dataInicio String Data de início de um intervalo de tempo, no formato AAAA-MM-DD. false
dataFim String Data de término de um intervalo de tempo, no formato AAAA-MM-DD. false
pagina Int Número da página de resultados. Default = 1 false
itens Int Número máximo de itens na página que se deseja obter com esta requisição. Default = 10 false
ordem String O sentido da ordenação: asc para A a Z ou 0 a 9, e desc para Z a A ou 9 a 0. Default = ASC false
ordenarPor String Nome do campo pelo qual a lista será ordenada: idLegislatura, id ou nome. Default = ID false 
DadosAbertos.deputados({ nome: "maria" })
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

deputadosById(id): Informações detalhadas sobre um deputado específico

Argument Type Value Required
id Int Número identificador de um deputado. true 
DadosAbertos.deputadosById(1)
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

deputadoDespesas({ id, idLegislatura, anos, meses, cnpjCpfFornecedor, pagina, itens, ordem, ordenarPor }): As despesas com exercício parlamentar do deputado

Argument Type Value Required
id Int O identificador numérico do parlamentar. true
idLegislatura array[Int] Número(s) identificador(es) de uma ou mais legislatura(s), separados por vírgulas. false
anos array[Int] Um ou mais ano(s) de ocorrência das despesas. false
meses array[Int] Um ou mais número(s) do(s) mês(es) de ocorrência das despesas. false
cnpjCpfFornecedor String CNPJ de uma pessoa jurídica, ou CPF de uma pessoa física, fornecedora do produto ou serviço (apenas números) false
pagina Int Número da página de resultados. Default = 1 false
itens Int Número máximo de itens na página que se deseja obter com esta requisição. Default = 10 false
ordem String O sentido da ordenação: asc para A a Z ou 0 a 9, e desc para Z a A ou 9 a 0. Default = ASC false
ordenarPor String Nome do campo pelo qual a lista será ordenada: idLegislatura, id ou nome. Default = ano false 
DadosAbertos.deputadoDespesas({ id: 1 })
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

deputadoDiscursos({ id, idLegislatura, dataInicio, dataFim, pagina, itens, ordem, ordenarPor }): Os discursos feitos por um deputado em eventos diversos

Argument Type Value Required
id Int O identificador numérico do parlamentar. true
idLegislatura array[Int] Número(s) identificador(es) de uma ou mais legislatura(s), separados por vírgulas. false
dataInicio String Data de início de um intervalo de tempo, no formato AAAA-MM-DD. false
dataFim String Data de término de um intervalo de tempo, no formato AAAA-MM-DD. false
pagina Int Número da página de resultados. Default = 1 false
itens Int Número máximo de itens na página que se deseja obter com esta requisição. Default = 10 false
ordem String O sentido da ordenação: asc para A a Z ou 0 a 9, e desc para Z a A ou 9 a 0. Default = ASC false
ordenarPor String Nome do campo pelo qual a lista será ordenada: idLegislatura, id ou nome. Default = dataHoraInicio false 
DadosAbertos.deputadoDiscursos({ id: 1 })
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

deputadoEventos({ id, dataInicio, dataFim, pagina, itens, ordem, ordenarPor }): Uma lista de eventos com a participação do parlamentar

Argument Type Value Required
id Int O identificador numérico do parlamentar. true
dataInicio String Data de início de um intervalo de tempo, no formato AAAA-MM-DD. false
dataFim String Data de término de um intervalo de tempo, no formato AAAA-MM-DD. false
pagina Int Número da página de resultados. Default = 1 false
itens Int Número máximo de itens na página que se deseja obter com esta requisição. Default = 10 false
ordem String O sentido da ordenação: asc para A a Z ou 0 a 9, e desc para Z a A ou 9 a 0. Default = ASC false
ordenarPor String Nome do campo pelo qual a lista será ordenada: idLegislatura, id ou nome. Default = dataHoraInicio false 
DadosAbertos.deputadoEventos({ id: 1 })
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

deputadoFrentes(id): As frentes parlamentares das quais um deputado é integrante

Argument Type Value Required
id Int O identificador numérico do parlamentar. true 
DadosAbertos.deputadoFrentes(1)
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

deputadoOcupacoes(id): Os empregos e atividades que o(a) deputado(a) já teve

Argument Type Value Required
id Int O identificador numérico do parlamentar. true 
DadosAbertos.deputadoOcupacoes(1)
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

deputadoOrgaos({ id, dataInicio, dataFim, pagina, itens, ordem, ordenarPor }): Os órgãos dos quais um deputado é integrante

Argument Type Value Required
id Int O identificador numérico do parlamentar. true
dataInicio String Data de início de um intervalo de tempo, no formato AAAA-MM-DD. false
dataFim String Data de término de um intervalo de tempo, no formato AAAA-MM-DD. false
pagina Int Número da página de resultados. Default = 1 false
itens Int Número máximo de itens na página que se deseja obter com esta requisição. Default = 10 false
ordem String O sentido da ordenação: asc para A a Z ou 0 a 9, e desc para Z a A ou 9 a 0. Default = ASC false
ordenarPor String Nome do campo pelo qual a lista será ordenada: idLegislatura, id ou nome. Default = dataInicio false 
DadosAbertos.deputadoOrgaos({ id: 1 })
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

deputadoProfissoes(id): As profissões que o parlamentar declarou à Câmara que já exerceu ou que pode exercer pela sua formação e/ou experiência

Argument Type Value Required
id Int O identificador numérico do parlamentar. true 
DadosAbertos.deputadoProfissoes(1)
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

refDeputadosCodSituacao(): As possíveis situações de exercício parlamentar de um deputado

Argument Type Value Required 
DadosAbertos.refDeputadosCodSituacao()
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

refDeputadosSituacao(): As possíveis situações de exercício parlamentar de um deputado

Argument Type Value Required 
DadosAbertos.refDeputadosSituacao()
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

Eventos():

coming soon

Frentes():

coming soon

legislaturas({ id, data, pagina, itens, ordem, ordenarPor }): Os períodos de mandatos e atividades parlamentares da Câmara

Argument Type Value Required
id Int Número da legislatura da qual se deseja os dados. false
data String Data no formato AAAA-MM-DD, false
dataFim String Data de término do intervalo de tempo do qual se deseja saber a composição da Mesa, no formato AAAA-MM-DD. false
pagina Int Número da página de resultados. Default = 1 false
itens Int Número máximo de itens na página que se deseja obter com esta requisição. Default = 10 false
ordem String O sentido da ordenação: asc para A a Z ou 0 a 9, e desc para Z a A ou 9 a 0. Default = DESC false
ordenarPor String Nome do campo pelo qual a lista será ordenada: idLegislatura, id ou nome. Default = id false 
DadosAbertos.legislaturas({ data: "2018-01-01" })
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

legislaturasById(id): Informações extras sobre uma determinada legislatura da Câmara

Argument Type Value Required
id Int Número da legislatura da qual se deseja os dados. true 
DadosAbertos.legislaturasById(1)
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

legislaturaMesa({ id, dataInicio, dataFim }): Quais deputados fizeram parte da Mesa Diretora em uma legislatura

Argument Type Value Required
id Int Número da legislatura da qual se deseja os dados. true
dataInicio String Dia de início do intervalo de tempo do qual se deseja saber a composição da Mesa, no formato AAAA-MM-DD. false
dataFim String Data de término do intervalo de tempo do qual se deseja saber a composição da Mesa, no formato AAAA-MM-DD. false 
DadosAbertos.legislaturaMesa({ id: 1 })
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

Partidos():

coming soon

Proposicoes():

coming soon

Referencias():

coming soon

votacoes({ id, idProposicao, idEvento, idOrgao, dataInicio, dataFim, pagina, itens, ordem, ordenarPor }): Lista das votações da Câmara

Argument Type Value Required
id array[String] Um ou mais identificador(es) alfanuméricos de votação. false
idProposicao array[Int] Um ou mais identificador(es) numéricos de proposições. false
idEvento array[Int] Identificador de um ou mais evento(s) realizado(s) na Câmara. false
idOrgao array[Int] Um ou mais identificador(es) numéricos de órgãos da Câmara. false
dataInicio String Data em formato AAAA-MM-DD para início do intervalo no qual tenham sido realizadas as votações a serem listadas. false
dataFim String Data em formato AAAA-MM-DD que define o fim do intervalo no qual tenham sido realizadas as votações a serem listadas. false
pagina Int Número da página de resultados. Default = 1 false
itens Int Número máximo de itens na página que se deseja obter com esta requisição. Default = 10 false
ordem String O sentido da ordenação: asc para A a Z ou 0 a 9, e desc para Z a A ou 9 a 0. Default = DESC false
ordenarPor String Nome do campo pelo qual a lista será ordenada: idLegislatura, id ou nome. Default = id false 
DadosAbertos.legislaturas({ data: "2018-01-01" })
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

votacoesById(id): Informações detalhadas sobre uma votação da Câmara

Argument Type Value Required
id Int Identificador alfanumérico da votação true 
DadosAbertos.votacoesById(1)
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

orientacoes(id): O voto recomendado pelas lideranças aos seus deputados em uma votação.

Argument Type Value Required
id Int Identificador alfanumérico da votação. true 
DadosAbertos.orientacoes(1)
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

votos(id): Como cada parlamentar votou em uma votação nominal e aberta

Argument Type Value Required
id Int Identificador alfanumérico da votação. true 
DadosAbertos.votos(1)
  .then((data) => console.log(data))
  .catch(err) => console.log(err);

Orgaos():

coming soon

Async / Await

Example usando Async & Await com express.js:

app.post("/dadosabertos/blocos", async (req, res) => {
  const { id, idLegislatura } = req.body;

  let blocos = await DadosAbertos.blocos({ id, idLegislatura });

  if (!blocos) return res.status(400).send("Nenhum bloco encontrado!");
  res.status(200).json(blocos);
});

Issues

https://github.com/gabrielpimentels/dadosabertos-js/issues

License

MIT License

Copyright (c) 2022 Gabriel Pimentel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

/dadosabertos-js/

    Package Sidebar

    Install

    npm i dadosabertos-js

    Repository

    github.com/gabrielpimentels/dadosabertos-js

    Homepage

    github.com/gabrielpimentels/dadosabertos-js#readme

    Weekly Downloads

    1

    Version

    0.0.5

    License

    MIT

    Unpacked Size

    31.3 kB

    Total Files

    5

    Last publish

    Collaborators

    • gabrielpimentels
    Try on RunKit
    Report malware