Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/senadores-chile/senadores

:shit: Datos publicos disponibles en la pagina www.senado.cl
https://github.com/senadores-chile/senadores

chile senadores

Last synced: 18 days ago
JSON representation

:shit: Datos publicos disponibles en la pagina www.senado.cl

Host: GitHub
URL: https://github.com/senadores-chile/senadores
Owner: senadores-chile
License: mit
Created: 2016-11-09T01:34:57.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2017-05-05T12:45:21.000Z (over 7 years ago)
Last Synced: 2024-09-26T09:21:53.100Z (about 2 months ago)
Topics: chile, senadores
Language: JavaScript
Homepage: https://senadores-chile.github.io/senadores/
Size: 69.3 KB
Stars: 5
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: readme.md
- License: license

Awesome Lists containing this project

README

# senadores [![npm version](https://img.shields.io/npm/v/senadores.svg?style=flat-square)](https://www.npmjs.com/package/senadores) [![Build Status](https://img.shields.io/travis/YerkoPalma/senadores/master.svg?style=flat-square)](https://travis-ci.org/YerkoPalma/senadores) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)

> Datos públicos disponibles en la página www.senado.cl

## Instalación

```bash
npm install --save senadores
```

## Uso

```javascript
var senadores = require('senadores')

senadores() // lista completa de senadores
senadores('Guirardi') // busca por nombre
senadores(1232156) // busca por rut
senadores({
partido: 'udi',
region: 'metropolitana',
asistencia: '<.85'
}, 'asistencia.sala') // busca todos los senadores del partido udi, distrito región metropolitana con asistencia menor a 85%
```

## API

### `senadores([options][, type])`

Existe una unica función expuesta, que recibe argumentos variables y opcionales como entrada. Si la operación es exitosa, la función resuelve en una promesa con un arreglo conteniendo la información solicitada, en caso de existir un error, la función arroja un `Error` con un mensaje especificando la falla.

#### `options`

El primer argumento de la función puede ser de tipo `string`, `number`, `array` u `object`. Si se trata de un `string` o `number` buscara **solo un** senador por nombre o rut/id respectivamente.
Si se trata de un `array`, se espera un arreglo de strings y/o numbers, donde se obtendra para cada uno, la información de un senador. En caso de tratarse de un objeto, se espera una serie de opciones para afinar la busqueda.
El resultado obtenido al final, dependerá de la variable `type` ingresada, por defecto, busca información básica de cada senador (más información en [type](#type)). Para el objeto, las propiedades de busqueda posibles son:

- `partido`: Siglas del partido politico.
- `region`: Nombre de la región (no sirve el número de región).
- `nombre`: Nombre del/la senador/a.
- `rut`: Rut a encontrar.
- `circunscripcion`: Número de la circunscripción.
- `telefono`: Télefono (de oficina) del senador.
- `email`: Email administrativo del senador.
- `cantidadSenadores`: Indica la cantidad máxima de senadores a consultar.
- `asistenciaSala`: String de busqueda de asistencia de sala. Si se trata de un número, busca asistencia exacta en porcentaje, también se puede ingresar un comparador lógico para buscar, ej: `'>90%'`. _Solo será considerado si el tipo de busqueda es `'asistencia.sala'`_.
- `periodoAsistenciaSala`: Periodo para buscar asistencia, para más información, consultar la API de [asistencia senadores](https://github.com/YerkoPalma/senadores-asistencia#asistenciaquery--options). _Solo será considerado si el tipo de busqueda es `'asistencia.sala'`_.
- `periodoAsistenciaComisiones`: Periodo para buscar asistencia, para más información, consultar la API de [asistencia senadores](https://github.com/YerkoPalma/senadores-asistencia#asistenciaquery--options). _Solo será considerado si el tipo de busqueda es `'asistencia.comisiones'`_.
- `ingresosElecciones`: String de busqueda de información de elecciones. Si se trata de un número, busca el ingreso más próximo, también se puede ingresar un comparador lógico para buscar, ej: `'>90000000'`. _Solo será considerado si el tipo de busqueda es `'elecciones.ingresos'`_.
- `gastosElecciones`: String de busqueda de información de elecciones. Si se trata de un número, busca el gasto más próximo, también se puede ingresar un comparador lógico para buscar, ej: `'>90000000'`. _Solo será considerado si el tipo de busqueda es `'elecciones.gastos'`_.
- `periodoViajesInternacionales`: Periodo para buscar viajes internacionales, para más información, consultar la API de [viajes senadores](https://github.com/YerkoPalma/senadores-viajes). _Solo será considerado si el tipo de busqueda es `'viajes'` o `'viajes.internacionales'`_.

#### `type`

Indicador del tipo de consulta que se esta realizando. Puede tener los siguientes valores:

- `'default'`: Obtiene detalle de los senadores.
- `'asistencia'`: Obtiene asistencia de sala y comisiones de los senadores.
- `'asistencia.sala'`: Obtiene asistencia de sala de los senadores.
- `'asistencia.comisiones'`: Obtiene asistencia de comisiones de los senadores.
- `'viajes'`: Obtiene información de viajes nacionales e internacionales de senadores.
- `'viajes.internacionales'`: Obtiene información de viajes internacionales de senadores.
- `'elecciones'`: Obtiene información de ingresos y gastos durante periodo de elecciones de cada senador.
- `'elecciones.ingresos'`: Obtiene información de ingresos durante periodo de elecciones de cada senador.
- `'elecciones.gastos'`: Obtiene información de gastos durante periodo de elecciones de cada senador.

## Otros enlaces

- [senadores-base](https://github.com/YerkoPalma/senadores-base) - Información basica y estatica de los senadores actuales de Chile.
- [senadores-asistencia](https://github.com/YerkoPalma/senadores-asistencia) - Observador de la asistencia de senadores tanto a sesiones de sala como a comisiones del senado de Chile.
- [senadores-detalle](https://github.com/YerkoPalma/senadores-detalle) - Detalle complementario a la información base de cada senador.
- [senadores-viajes](https://github.com/YerkoPalma/senadores-viajes) - Obtiene el detalle de los viajes realizados por senadores de Chile.
- [senadores-elecciones](https://github.com/YerkoPalma/senadores-elecciones) - Contiene la información de las ultimas elecciones de senadores, obtenidas desde el Servel.

## Licencia