propublica-congress-node
=================


> Big ups to Nick Bottomley (http://github.com/nickb1080), who wrote most of this code. We've just updated it to hit the updated ProPublica endpoints, as the API is now maintained there.

Node wrapper for ProPublica Congress API (formerly NYT). REST API Docs.

Usage

``javascript

var Congress = require( 'propublica-congress-node' );
var client = new Congress( API_KEY );

client.memberLists({
congressNumber: '114',
chamber: 'house'
}).then(function(res) {
console.log(res);
});

`

This package works in the browser. To generate a version that will provide a Congress browser global, go to the project root and run (assuming you have browserify installed globally):

`sh
browserify -s Congress ./ > congress-browser.js
`

Fair warning: the standalone, browserified pacakage is pretty darn big.

propublica-congress-node is a straight-forward wrapper around the ProPublica Congress API (formerly maintained by the NYT). The ProPublica site has comprehensive documentation as well as example results for each query.

Internally, propublica-congress-node uses string interpolation on the API endpoints detailed in the API documentation. For example, the bill details endpoint has a url structure as follows

`
https://api.propublica.org/congress/{version}/{congress-number}/{chamber}/members.{response-format}
`

A valid request needs to fill in this URL with the following parameters: version, congress-number, chamber, and a response-format.

Of these, only chamber is required. The version defaults to 'v1' (the only version, currently), congress-number defaults to 114 (the current congress, in 2017), and response-format defaults to JSON (also the only offering, currently).

Each method takes a parameters object, which it "dasherizes" (turns the keys from camelCase to dash-case), then interpolates these values into the string.

The API key (request one from ProPublica) must be passed to the constructor and is automatically added to every request in the X-API-Key header.

The example at the top

`javascript
var Congress = require( 'propublica-congress-node' );
var client = new Congress( 'API_KEY' );

client.memberLists({
chamber: 'house'
}).then(function(res) {
console.log(res);
});
`
will dispatch a request to the following URL:

`
https://api.propublica.org/congress/v0/114/house/members.json
`

Every method returns a ES6 Promise.

API

- Bills
- billDetails
- billSubjects
- billAmendments
- billRelatedBills
- billCosponsors

- Members
- memberLists
- memberBioAndRoles
- membersNew
- membersCurrentByStateOrDistrict
- membersLeavingOffice
- memberVotePositions
- memberVoteComparison
- memberCosponsoredBills
- memberSponsorshipComparison
- memberFloorAppearances

- Nominees
- nomineeLists
- nomineeDetails
- nomineesByState

- Other
- statePartyCounts
- committeeList
- committeeRoster
- chamberSchedule

- Votes
- votesRollCall
- votesByType
- votesByDate
- votesNominations

Bills

$3

Endpoint documentation: Recent bills

Parameters:
`
- congressNumber
- chamber
- billType
`

$3

Endpoint documentation: Bills by member

Parameters:
`
- memberId
- billType
`

$3

Endpoint documentation: Bill details

Parameters:
`
- congressNumber
- billId
`

$3

Endpoint documentation: Bill subjects, amendments, and related bills _with type set to "subjects"_

Parameters:
`
- congressNumber
- billId
`

$3

Endpoint documentation: Bill subjects, amendments, and related bills _with type set to "amendment"_

Parameters:
`
- congressNumber
- billId
`

$3

Endpoint documentation: Bill subjects, amendments, and related bills _with type set to "related"_

Parameters:
`
- congressNumber
- billId
`

$3

Endpoint documentation: Bill cosponsors

Parameters:
`
- congressNumber
- billId
`

Members

$3

Endpoint documentation: Member lists

Parameters:
`
- congressNumber
- chamber
`

$3

Endpoint documentation: Member detail, bio and roles

Parameters:
`
- memberId
`

$3

Endpoint documentation: New members

Parameters:
`
- _None_
`

$3

Endpoint documentation: Current members by state/district

Parameters:
`
- chamber
- state
- district (for house only)
`

$3

Endpoint documentation: Members leaving office

Parameters:
`
- congressNumber
- chamber
`

$3

Endpoint documentation: Member vote positions

Parameters:
`
- memberId
`

$3

Endpoint documentation: Member vote comparison

Parameters:
`
- memberId1
- memberId2
- congressNumber
- chamber
`

$3

Endpoint documentation: Member cosponsorship comparison

Parameters:
`
- memberId1
- memberId2
- congressNumber
- chamber
`

$3

Endpoint documentation: Bills cosponsored by a member

Parameters:
`
- memberId
- type ('cosponsored' or 'withdrawn')
`

$3

Endpoint documentation: ~~Member floor appearances~~ Not yet implemented in ProPublica API, but maybe coming soon.

Parameters:
`
- memberId
`

Nominees

$3

Endpoint documentation: Nominee lists

Parameters:
`
- congressNumber
- type ('received', 'updated', 'confirmed', 'withdrawn')
`

$3

Endpoint documentation: Nominee details

Parameters:
`
- congressNumber
- nomineeId
`

$3

Endpoint documentation: Nominees by state

Parameters:
`
- congressNumber
- state
`

Other

$3

Endpoint documentation: State party counts

Parameters:
`
- _NONE_
`

$3

Endpoint documentation: Committees and committee members _but doesn't accept a committee id_

Parameters:
`
- congressNumber
- chamber
`

$3

Endpoint documentation: Committees and committee members _but requires a committee id_

Parameters:
`
- congressNumber
- chamber
- committeeId
`

Votes

$3

Endpoint documentation: Roll-call votes

Parameters:
`
- congressNumber
- chamber
- sessionNumber
- rollCallNumber
`

$3

Endpoint documentation: Votes by type

Parameters:
`
- congressNumber
- chamber
- voteType
`

$3

Endpoint documentation: Votes by date

Parameters:
`
- chamber
- year
- month
`

$3

Endpoint documentation: nominationVotes

Parameters:
`
- congressNumber
`

Parameter Validation


propublica-congress-node validates all parameters passed to methods. Generally, parameter strings are checked with contains, alphanumeric, numeric, and date. Contains checks if a value is in a pre-set list. Each parameter will also accept the camelCased version of it's key.

`
'bill-id': alphanumeric
'bill-type': contains // => ['introduced', 'updated', 'passed', 'major']
'chamber': contains // => ['house', 'senate']
'committee-id': alphanumeric,
'congress-number': contains // => [105, 106, 107, 108, 109, 110, 111, 112, 113]
'cosponsor-type': contains // => ['cosponsored', 'withdrawn']
'district': numeric
'end-date': date
'member-id': alphanumeric
'member-id-2': alphanumeric
'member-id-1': alphanumeric
'nomination-category': contains // => ['received', 'updated', 'confirmed', 'withdrawn']
'nominee-id': alphanumeric
'resource': contains // => ['subjects', 'amendments', 'related'] ),
'response-format': contains // => ['.json', '.xml']
'roll-call-number': numeric
'session-number': numeric
'start-date': date
'state': contains // => ['AL', 'AK', 'AZ', 'AR', 'CA', 'CO', 'CT', 'DE', 'FL', 'GA', 'HI', 'ID', 'IL', 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE', 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'OH', 'OK', 'OR', 'PA', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VT', 'VA', 'WA', 'WV', 'WI', 'WY']
'vote-type': contains // => ['missed_votes', 'party_votes', 'loneno', 'perfect'] ),
'version': // => must be v3
'year': numeric
'month': numeric
``