Giter VIP home page Giter VIP logo

nyt-congress-node's Introduction

nyt-congress-node

NPM

Build Status

Node wrapper for NYT Congress API.

API Docs

Plan to add methods for all endpoints; currently only supports endpoints listed under Bills.

Usage

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

  client.billDetails({
    'bill-id': 'HR2397',
    'congress-number': '113'
  }).then( function ( res ) {
    console.log( res );
  });

Options passed to each method will be inserted into the relevant endpoint URL scheme based on their key. billDetails has the endpoint http://api.nytimes.com/svc/politics/{version}/us/legislative/congress/{congress-number}/bills/{bill-id}{response-format}

version and response-format have defaults, so we don't need to include them. bill-id and congress-number get inserted into this url. Final request is made to:

http://api.nytimes.com/svc/politics/v3/us/legislative/congress/113/bills/HR2397.json?api-key={API_KEY}

All API call methods return promises.

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):

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

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

nyt-congress-node's People

Contributors

bttmly avatar wlabranche avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.