node-markitondemand

Node.js library for accessing the Markit On Demand APIs . Markit On Demand 'offers an opportunity to explore the complexity of financial data in building great tools'. The library gives you the ability to lookup stock symbols and and get stock quotes.

Getting Started

To install the npm package:

    $ npm install node-markitondemand --save

Using the Library

The APIs available in this library:

• lookup()
• getStock()
• getQuote()
• getQuotes()

lookup()

lookup(symbol, callback(err, stock));

Used to search stocks.

   var markit = require('node-markitondemand');
 
   markit.lookup('AAPL', function(err, data) {
     // Where data is an array of stock symbols 
     console.log(data);
   });

getStock()

getStock is an alias of lookup()

Used to search stocks.

getQuote()

getQuote(symbol, callback(err, stock));

Used to get latest stock data.

   var markit = require('node-markitondemand');
 
   markit.getQuote('AAPL', function(err, stock) {
     // Where stock is an object of stock data 
     console.log(stock);
   });

getQuotes()

getQuotes(symbols, callback(err, stock));

Used to get latest stock data for multiple symbols.

Warning: Using this function is not recommended. You may get throttled on excessive requests to the API.

   var markit = require('node-markitondemand');
 
   markit.getQuotes(['AAPL', 'F'], function(err, stocks) {
     // Where stocks is an array of objects of stock data 
     console.log(stocks);
   });

Running Tests

To run tests (requires mocha):

    $ npm test

To run test coverage (requires jscoverage):

    $ npm run coverage

Author

Ahmed Farooki ahmedfarooki@gmail.com

License

The MIT License (MIT)

Copyright (c) 2015 Ahmed Farooki

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.