Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bennycode/trading-signals

Technical indicators to run technical analysis with JavaScript & TypeScript. 📈
https://github.com/bennycode/trading-signals

analysis cryptotrading dema dma ema financial financial-analysis hacktoberfest indicator macd roc rsi signals sma smma technical-analysis technical-indicators trading trading-signals typescript

Last synced: about 2 months ago
JSON representation

Technical indicators to run technical analysis with JavaScript & TypeScript. 📈

Awesome Lists containing this project

README 

        
# Trading Signals



![Language Details](https://img.shields.io/github/languages/top/bennycode/trading-signals) ![Code Coverage](https://img.shields.io/codecov/c/github/bennycode/trading-signals/main) ![License](https://img.shields.io/npm/l/trading-signals.svg) ![Package Version](https://img.shields.io/npm/v/trading-signals.svg)



Technical indicators and overlays to run technical analysis with JavaScript / TypeScript.



## Motivation



The "trading-signals" library provides a TypeScript implementation for common technical indicators with arbitrary-precision decimal arithmetic.



The main focus of this library is on the accuracy of calculations, but using the provided [faster implementations][2] you can also use it where performance is important.



All indicators can be updated over time by streaming data (prices or candles) to the `update` method. Some indicators also provide `static` batch methods for further performance improvements when providing data up-front during a backtest or historical data import.



## Benefits & Features



- **Accurate.** Indicators with intervals will return a result only when the period is reached.

- **Convenient.** Indicators with intervals will save their all-time highs and lows.

- **Fast.** If you need high throughput, you can use the included [faster implementations][2].

- **Flexible.** All advanced indicators support different smoothing overlays (WSMA, etc.).

- **Live.** It allows for the replacement of values, enabling live charting.

- **Modern.** Uses ECMAScript Modules (ESM) syntax.

- **Precise.** Better accuracy than calculating with primitive numbers thanks to [big.js][1].

- **Robust.** Checked against common division by zero mistakes.

- **Tested.** Code coverage is 100%. No surprises when using it.

- **Typed.** Source code is 100% TypeScript. No need to install external typings.

- **Verified.** All results are verified with [other libraries](#alternatives) to guarantee correctness.

- **Versatile.** Indicators can be updated up-front or by streaming prices.



## Technical Indicator Types



- Trend indicators: Measure the direction of a trend (uptrend, downtrend or sideways trend)

- Volume indicators: Measure the strength of a trend (based on volume)

- Volatility indicators: Measure how much disagreement there is in the market based on price (statistical measure of its dispersion)

- Momentum indicators: Measure the strength of a trend (based on price / speed of price movement)



## Supported Technical Indicators



1. Acceleration Bands (ABANDS)

1. Accelerator Oscillator (AC)

1. Average Directional Index (ADX)

1. Average True Range (ATR)

1. Awesome Oscillator (AO)

1. Bollinger Bands (BBANDS)

1. Bollinger Bands Width (BBW)

1. Center of Gravity (CG)

1. Commodity Channel Index (CCI)

1. Directional Movement Index (DMI / DX)

1. Double Exponential Moving Average (DEMA)

1. Dual Moving Average (DMA)

1. Exponential Moving Average (EMA)

1. Mean Absolute Deviation (MAD)

1. Momentum (MOM / MTM)

1. Moving Average Convergence Divergence (MACD)

1. On-Balance Volume (OBV)

1. Rate-of-Change (ROC)

1. Relative Strength Index (RSI)

1. Simple Moving Average (SMA)

1. Stochastic Oscillator (STOCH)

1. Stochastic RSI (STOCHRSI)

1. True Range (TR)

1. Weighted Moving Average (WMA)

1. Wilder's Smoothed Moving Average (WSMA / WWS / SMMA / MEMA)



Utility Methods:



1. Average / Mean

1. Standard Deviation

1. Rolling Standard Deviation



## Usage



```typescript

import {Big, SMA} from 'trading-signals';



const sma = new SMA(3);



// You can add numbers individually:

sma.update(40);

sma.update(30);

sma.update(20);



// You can add multiple numbers at once:

sma.updates([20, 40, 80]);



// You can add strings:

sma.update('10');



// You can replace a previous value (useful for live charts):

sma.replace('40');



// You can add arbitrary-precision decimals:

sma.update(new Big(30));



// You can get the result in various formats:

console.log(sma.getResult().toFixed(2)); // "40.00"

console.log(sma.getResult().toFixed(4)); // "40.0000"

```



### When to use `update(...)`?



You have to call an indicator's `update` method to enter input data. The update method may or may not return a result from the indicator depending on whether the minimum amount of input data has been reached.



### When to use `getResult()`?



You can call `getResult()` at any point in time, but it throws errors unless an indicator has received the minimum amount of data. If you call `getResult()`, before an indicator has received the required amount of input values, a `NotEnoughDataError` will be thrown.



**Example:**



```ts

import {SMA} from 'trading-signals';



// Our interval is 3, so we need 3 input values

const sma = new SMA(3);



// We supply 2 input values

sma.update(10);

sma.update(40);



try {

  // We will get an error, because the minimum amount of inputs is 3

  sma.getResult();

} catch (error) {

  console.log(error.constructor.name); // "NotEnoughDataError"

}



// We will supply the 3rd input value

sma.update(70);



// Now, we will receive a proper result

console.log(sma.getResult().valueOf()); // "40"

```



Most of the time, the minimum amount of data depends on the interval / time period used.



## Performance



### Arbitrary-precision decimal arithmetic



JavaScript is very bad with numbers. When calculating `0.1 + 0.2` it shows you `0.30000000000000004`, but the truth is `0.3`.



![JavaScript arithmetic](https://raw.githubusercontent.com/bennycode/trading-signals/HEAD/js-arithmetic.png)



As specified by the ECMAScript standard, all arithmetic in JavaScript uses [double-precision floating-point arithmetic](https://en.wikipedia.org/wiki/Double-precision_floating-point_format), which is only accurate until certain extent. To increase the accuracy and avoid miscalculations, the [trading-signals](https://github.com/bennycode/trading-signals) library uses [big.js][1] which offers arbitrary-precision decimal arithmetic. However, this arbitrary accuracy comes with a downside: Calculations with it are not as performant as with the primitive data type `number`.



### Faster implementations



To get the best of both worlds (high accuracy & high performance), you will find two implementations of each indicator (e.g. `SMA` & `FasterSMA`). The standard implementation uses [big.js][1] and the `Faster`-prefixed version uses common `number` types. Use the standard one when you need high accuracy and use the `Faster`-one when you need high performance:



```ts

import {FasterSMA} from './SMA/SMA';



const fasterSMA = new FasterSMA(5);

console.log(fasterSMA.updates([1, 2, 3, 4, 5]));

```



```ts

import {FasterStochasticRSI, FasterSMA} from 'trading-signals';



const fasterStochRSI = new FasterStochasticRSI(3, FasterSMA);

fasterStochRSI.update(1);

fasterStochRSI.update(2);

fasterStochRSI.update(3);

fasterStochRSI.update(4);

fasterStochRSI.update(5);

fasterStochRSI.update(6);



console.log(fasterStochRSI.getResult());

```



### Benchmarks



You can run `yarn start:benchmark` to see the runtime performance of each technical indicator on your machine. This will give you an understanding of which indicators can be calculated faster than others.



## Disclaimer



The information and publications of [trading-signals](https://github.com/bennycode/trading-signals) do not constitute financial advice, investment advice, trading advice or any other form of advice. All results from [trading-signals](https://github.com/bennycode/trading-signals) are intended for information purposes only.



It is very important to do your own analysis before making any investment based on your own personal circumstances. If you need financial advice or further advice in general, it is recommended that you identify a relevantly qualified individual in your jurisdiction who can advise you accordingly.



## Alternatives



- [Cloud9Trader Indicators (JavaScript)](https://github.com/Cloud9Trader/TechnicalIndicators)

- [Crypto Trading Hub Indicators (TypeScript)](https://github.com/anandanand84/technicalindicators)

- [Jesse Trading Bot Indicators (Python)](https://docs.jesse.trade/docs/indicators/reference.html)

- [libindicators (C#)](https://github.com/mgfx/libindicators)

- [Pandas TA (Python)](https://github.com/twopirllc/pandas-ta)

- [Technical Analysis for Rust (Rust)](https://github.com/greyblake/ta-rs)

- [Technical Analysis Library using Pandas and Numpy (Python)](https://github.com/bukosabino/ta)

- [Tulip Indicators (ANSI C)](https://github.com/TulipCharts/tulipindicators)

- [ta4j (Java)](https://github.com/ta4j/ta4j)



## Maintainers



[![Benny Neugebauer on Stack Exchange][stack_exchange_bennycode_badge]][stack_exchange_bennycode_url]



## ⭐️ Become a TypeScript rockstar! ⭐️



This package was built by Benny Code. Checkout my [**TypeScript course**](https://typescript.tv/) to become a coding rockstar!



[](https://typescript.tv/)



[1]: http://mikemcl.github.io/big.js/

[2]: #faster-implementations

[stack_exchange_bennycode_badge]: https://stackexchange.com/users/flair/203782.png?theme=default

[stack_exchange_bennycode_url]: https://stackexchange.com/users/203782/benny-neugebauer?tab=accounts



## License



This project is [MIT](./LICENSE) licensed.