opencam

A JavaScript Wrapper to use API Dados Abertos da Câmara

See more about the API: https://dadosabertos.camara.leg.br/

Installation

npm install opencam --save

Dependencies

This library depends on fetch to make requests to the "Dados Abertos da Câmara" API. For environments that don't support fetch, you'll need to provide a polyfill to browser or polyfill to Node.

How to use

ES6

import Opencam from 'opencam';

const opencam = new Opencam({});

// using  method
opencam.deputies.search("Maria");

CommonJS

const Opencam = require('opencam').default;

const opencam = new Opencam({});

// using  method
opencam.deputies.search("Maria");

UMD in Browser

UMD files are located in the ./dist folder

.
├── dist                   # UMD Folder
|   └── opencam.umd.js     # UMD File - File to use with the html script tag
|__ lib                    # Compiled files

Methods

Follow the methods that the library provides.

• search
• details
• expenses
• events
• agencies
• board

deputies.search(name)

Search for informations about deputy with provided name.

Arguments

| Argument | Type | Options | |----------|---------|-------------------| |name |string | 'Any search query'|

Example

opencam.deputies.search('Maria')
  .then(data => {
    // do what you want with the data
  })

deputies.details(id)

Complete informations about deputy with provided ID.

Arguments

| Argument | Type | Options | |----------|---------|-------------------| |ID |integer| 'Any search query'|

Example

opencam.deputies.details(000000)
  .then(data => {
    // do what you want with the data
  })

deputies.expenses(id)

Information on the expenses of a Member with ID provided

Arguments

| Argument | Type | Options | |----------|---------|-------------------| |ID |integer| 'Any search query'|

Example

opencam.deputies.expenses(000000)
  .then(data => {
    // do what you want with the data
  })

deputies.events(id)

Informations about events with provided ID.

Arguments

| Argument | Type | Options | |----------|---------|-------------------| |ID |integer| 'Any search query'|

Example

opencam.deputies.events(000000)
  .then(data => {
    // do what you want with the data
  })

deputies.agencies(id)

Informations about agencies with provided ID.

Arguments

| Argument | Type | Options | |----------|---------|-------------------| |ID |integer| 'Any search query'|

Example

opencam.deputies.agencies(000000)
  .then(data => {
    // do what you want with the data
  })

deputies.board(id)

Informations about board with provided ID.

Arguments

| Argument | Type | Options | |----------|---------|-------------------| |ID |integer| 'Any search query'|

Example

opencam.deputies.board(000000)
  .then(data => {
    // do what you want with the data
  })

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details