A node.js library for candlestick pattern detection. It is written in pure javascript and solves the need for node-gyp builds.
To install the most recent release from npm, run:
npm install candlestick
isBullishKicker(previous, current)
isBearishKicker(previous, current)
isShootingStar(previous, current)
bullishKicker(dataArray)
bearishKicker(dataArray)
shootingStar(dataArray)
Mandatory fields of previous
and current
are:
{
...
open: Number, // security's opening price
high: Number, // security's highest price
low: Number, // security's lowest price
close: Number // security's closing price
}
Parameter dataArray
is an array of OHLC objects like previous
or current
.
Use two OHLCs to assess the pattern:
const cs = require('candlestick');
// Market data: previous and current ticks
const prev = {
ticker: 'ORCL',
date: '2016-09-15',
open: 40.18,
high: 41.03,
low: 40.09,
close: 40.86
};
const curr = {
ticker: 'ORCL',
date: '2016-09-16',
open: 39.61,
high: 39.35,
low: 38.71,
close: 38.92
};
console.log(cs.isBullishKicker(prev, curr)); // false
console.log(cs.isBearishKicker(prev, curr)); // true
Get the points in a dataset where the pattern was found:
const cs = require('candlestick');
// Market data: array of ticks
const data = [
{
ticker: 'GE',
date: '2016-02-01',
open: 29.01,
high: 29.03,
low: 28.56,
close: 28.64
},
{ ... },
{ ... },
...
];
console.log(cs.shootingStar(data));
// result: [{ ticker: 'GE', date: '2016-02-10', ... }, { ticker: 'ORCL', date: '2016-07-11', ... }]
npm test
You are welcome to contribute to this library creating issues and pull requests.
This project is licensed under the MIT license. See the LICENSE file for more info.