@broken_bones/stocks.js

NOTE: This is a fork of another project that was left abandoned I have fixed it to the best I can

Stocks.js

Easy-to-use stocks API for Node.js and the browser

‌

#

stocks.js allows easy retrieval of stock data - without having to pay a single
dollar. The library uses Alpha Vantage as its
data source. Next to regular time series data, there are a bunch of technical
indicators that can be tracked with this library.

> :bulb: This library is very new, so you might experience issues. If you do,
please report them at the issues
section.

This is an example of regular stock time series retrieval
(click to run):

NOTE: This is a fork of another project that was left abandoned I have fixed it to the best I can

``js
// Let's get the stock data of Tesla Inc. for the last 10 minutes
var result = await stocks.timeSeries({
symbol: 'TSLA',
interval: '1min',
amount: 10
});
`

And this is an example of how to retrieve a technical
indicator
(click to run):

`js
// Let's get the directional movement index of Microsoft Corporation for the
// last 20 years, with 10 data points used to calculate every point
var result = await stocks.technicalIndicator({
symbol: 'MSFT',
interval: 'monthly',
indicator: 'ADX',
time_period: 10
});
`

Getting started


The first step is downloading the dist/stocks.js file to your local machine.
Sadly, we don't host this file yet, but we will get to that soon. Link the file
in your .html file:

`html

`

You can also install stocks.js with npm (latest
version required):

`cmd
npm i @broken_bones/stocks.js --save
`

Now you have to request your personal API Key at Alpha Vantage. Claim your
API Key here. Now in another
.js file, write the following code:

`js
const Stocks = require("@broken_bones/stocks.js")
var stocks = new Stocks('XXXX'); // replace XXXX with your API Key
`

Basically, you're good to go! You can use any of the functions without a hassle
now. View the Usage paragraph below to see how you can fetch data.

Usage

At this moment, stocks.js supports 3 stock market data functions. Be sure to
read through the 'Getting Started' section before reading this!

$3

This function allows you to retrieve data from now, up to 20 years to the past.
The basic usage is as follows:

`js
var result = await stocks.timeSeries(options);
`

where options is an object containing any of the following options:

* REQ symbol, the symbol of the stock you want to follow. An example of this
is 'TLSA'. There is no list of symbols, I have requested a list at Alpha
Vantage.
* REQ interval, the interval of the data points you want to retrieve. Choose
from any of the following intervals: '1min', '5min', '15min', '30min', '60min',
'daily', 'weekly' and 'monthly'. Intervals 1min-60min typically span back to the
past 10 to 15 active trading days. Intervals daily-monthly span up to 20 years.
* amount, the amount of data points to fetch. If not specified, will return
all possible data points up to a maximum twenty years ago.
* start & end, the start and end dates from which to get data from in between.
_Cannot_ be used in combination with the amount option. For any interval shorter
than daily, specify intraday dates.

So an example of options could be:

`js
var options = {
symbol: 'AAPL',
interval: 'weekly',
amount: 52
};
`

Or to get data in between two dates (click to run):

`js
var options = {
symbol: 'TSLA',
interval: 'daily',
start: new Date('2017-07-01'),
end: new Date('2017-07-09')
}
`

The result of such a request is an array with amount elements (or every
element between start and end), every element is an object that includes the
following keys and corresponding values:

`js
close, high, low, open, volume, date
`

$3

This function allows you to fetch certain technical indicators regarding the
stock. The basic usage is as follows:

`js
var result = await stocks.technicalIndicator(options);
`

where options is an object containing any of the following options:

* REQ symbol, the symbol of the stock you want to follow. An example of this
is 'TLSA'. There is no list of symbols, I have requested a list at Alpha
Vantage.
* REQ indicator, the indicator of which you want to fetch data. The list of
indicators can be found here.
* REQ interval, the interval of the data points you want to retrieve. Choose
from any of the following intervals: '1min', '5min', '15min', '30min', '60min',
'daily', 'weekly' and 'monthly'. Any interval shorter than daily will only fetch
the data points of the current day.
* REQ time_period, the time period to calculate certain indicators from. For
example, if set to 10, the indicator value will be calculated using 10 data
points. Does not affect all indicators.
* amount, the amount of data points to fetch. If not specified, will return
all possible data points up to a maximum twenty years ago.
* start & end, the start and end dates from which to get data from in between.
_Cannot_ be used in combination with the amount option. For any interval shorter
than daily, specify intraday dates.
* series_type, can be either close, open, high or low. Not all
indicators require this

So an example of options could be:

`js
var options = {
symbol: 'NOK',
interval: '60min',
amount: 24,
time_period: 3,
indicator: 'ADX'
};
`

The result of such a request is an array with amount elements, every element
is an object that includes the following keys and corresponding values:

`js
(indicator name), date
`

$3

This function will fetch the US sector performance calculated from S&P500
incumbents. The basic usage is as follows:

`js
var result = await stocks.sectorPerformance(options);
`

where options is an object containing any of the following options:

* REQ timespan, the timespan of which to get the sector performance. Choose
from any of the following timespans: 'real-time', '1day', '5day', '1month',
'3month', 'year-to-date', '1year', '3year', '5year', '10year'

So an example of options could be
(click to run):

`js
var options = {
timespan: 'year-to-date'
};
`

The result of such a request will be an object containing the following values:

`js
Utilities, Consumer Staples, Real Estate, Consumer Discretionary,
Communication Services, Materials, Financials, Health Care,
Information Technology, Industrials, Energy
``

Contributing

If you want to contribute to this project, please read the contributing guide
over here. You can also participate in the discussions at the issues
section, every opinion we can
get is useful.

Further notices

All the data comes from Alpha Vantage, although
they exist for some time now, it is quite unclear what their business model is.
They also do not provide a lot of information on their sources and why an API
Key is needed. So please note the risk that from one day to the other their
service might stop.