stock-quote

Real time stock quote data retrieved from yahoo-stocks using promises.

Info

Supports all the Exchanges from listed on yahoo finance.

Yahoo finance provides stock price and details for stocks using a particular Id and extension. For instance, Hdfc Bank Ltd. listed in NSE(National Stock Exchange India) has symbol as HDFCBANK and extension as NS. Similarly, in BSE the symbol is same but the extension is BO. Please check the Usage section for more detailed usage.

You can get the list of exchanges from the following URL:

https://help.yahoo.com/kb/SLN2310.html

Install

npm i stock-quote

Usage

Stocks in NYSE do not require any extension as mentioned in the above specified URL. To get stock quote of Google use the following code snippet.

const quote = require('stock-quote');
quote.getQuote('GOOGL') // or quote.getQuote('GOOGL', '');
.then( (data) => {
    console.log(JSON.stringify(data, null, 4));
});

Stocks outside NYSE require a corresponding extenstion for example:

Bombay Stock Exchange has extension as BO, Australian Stock Exchange has extension has AXB. etc. To retrieve price of a stock listed in any of such exchanges use the following snippet.

const quote = require('stock-quote');
quote.getQuote('HDFCBANK', 'NS')
.then( (data) => {
    console.log(JSON.stringify(data, null, 4));
});

Data Format

The data returned when the promise is resolved will have the following format:

{

"symbol": "AAPL",

"currency": "USD",

"currentPrice": 188.58,

"totalRevenue": "247.42B",

"ebitda": "76.38B",

"cashPerShare": 17.892,

"currentRatio": 1.456,

"quickRatio": 1.235,

"debtToEquity": 96.029,

"revenuePerShare": 48.318,

"returnOnEquity": "40.86%",

"grossProfits": "88.19B",

"freeCashflow": "43.84B",

"operatingCashflow": "67.22B",

"grossMargins": "38.30%",

"operatingMargins": "26.70%",

"profitMargins": "21.55%",

"ebitdaMargins": "30.87%"

}