@trade-rhythm/technical-indicators
v1.1.1
Published
Technical indicators for algo trading
Downloads
11
Readme
Technical Indicators
A ~4kb (min, br) library that helps with technical analysis of financial data.
Why another technical indicator library?
Most libraries I could find assume the user has all the data up-front (like when running analysis on historical data). I wanted to be able use these indicators when data was streaming in over time. Thus, indicators in this library have two special features:
- All indicators can be serialized and and deserialed.
- All indicators follow the "iterator" pattern (where you don't need all the data up front).
These features are helpful in scenarios when you want to calculate an indicator's value over some streaing data and the data comes in over long periods of time. For example, lets say that you wanted to calculate an EMA(200)
of some dataset where new data comes in ever hour (like an hour bar for example). With this library, you can instanciate your indicator, pass in the next value, and then serialize the indicator back to a DB with out having to keep the indicator in memory the whole time it is being calculated.
Also, all indicators can be reset with the reset()
method.
Roadmap
- [x] ADX
- [x] AO
- [x] ATR
- [x] BB
- [x] CCI
- [x] CE
- [x] Cross
- [x] DMI
- [x] EMA
- [x] ER
- [x] FAST_STOCH
- [x] KC
- [x] MACD
- [x] MAD
- [x] MAX - Highest value in a given timeframe
- [x] MFI
- [x] MIN - Lowest value in a given timerframe
- [x] OBV
- [x] PPO
- [x] ROC
- [x] RSI
- [x] SD
- [x] SLOW_STOCH
- [x] SMA
- [x] TR - True Range (used by ATR)
- [ ] KST
- [ ] PSAR
- [ ] TRIX
Probably more! If you have a request, please create an issue. :)
Others
- Window
Usage
Node
import { EMA, Cross, parse } from "@trade-rhythm/technical-indicators";
// init some indicators
const ema = new EMA(9);
const cross = new Cross();
// do something with them
function handleNewData(bar) {
const value = ema.next(bar.close); // or ema.nextBar(bar);
if (cross.over(value, bar.close)) {
// Do something!
}
}
// serialize indicators to JSON
const state = { ema, cross };
const json = JSON.stringify(state);
// deserialize
const newState = parse(json);
You can also import indicators individually with
import EMA from '@trade-rhythm/technical-indicators/dist/EMA
Deno / Browser
import {
EMA,
Cross,
parse,
} from "https://unpkg.com/@trade-rhythm/technical-indicators";
Acknowledgements
- Most of these indicators are a port from this awesome library in Rust: https://github.com/greyblake/ta-rs