# bfx-hf-indicators

> A library of trading indicators for Node.JS

Latest version **2.0.8** (published 2021-05-13) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install bfx-hf-indicators
pnpm add bfx-hf-indicators
yarn add bfx-hf-indicators
bun add bfx-hf-indicators
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.8 |
| Published | 2021-05-13 |
| First published | 2018-10-17 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 457.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 57 |
| Author | Bitfinex |
| Maintainers | robertkowalski |
| Keywords | honey framework, bitfinex, bitcoin, BTC |

## Links

- npm: https://www.npmjs.com/package/bfx-hf-indicators
- Repository: https://github.com/bitfinexcom/bfx-hf-indicators
- Homepage: https://github.com/bitfinexcom/bfx-hf-indicators#readme
- Issues: https://github.com/bitfinexcom/bfx-hf-indicators/issues
- npm.io page: https://npm.io/package/bfx-hf-indicators

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [sprintf-js](https://npm.io/package/sprintf-js.md) ^1.1.1
- [bignumber.js](https://npm.io/package/bignumber.js.md) ^9.0.0

## Recent versions

- 2.0.8 (latest) — 2021-05-13
- 2.0.7 — 2021-05-12
- 2.0.6 — 2021-04-22
- 2.0.5 — 2021-04-12
- 2.0.4 — 2020-03-30
- 2.0.3 — 2019-12-19
- 2.0.2 — 2019-10-10
- 2.0.1 — 2019-09-23
- 2.0.0 — 2019-09-11
- 1.0.5 — 2019-06-25
- 1.0.3 — 2019-06-20
- 1.0.2 — 2018-10-27
- 1.0.1 — 2018-10-19
- 1.0.0 — 2018-10-17

## README

## Bitfinex Indicator Library for Node.JS

[![Build Status](https://travis-ci.org/bitfinexcom/bfx-hf-indicators.svg?branch=master)](https://travis-ci.org/bitfinexcom/bfx-hf-indicators)

This repo contains a collection of trading indicators implemented to support incremental updates, both from trade and candle data (depending on the indicator).

### Features
* Average True Range
* Normalised Average True Range
* Acceleration
* Accumulation/Distribution
* Accumulative Swing Index
* Arnoud Legoux Moving Average
* Aroon
* Average Directional Index
* Awesome Oscillator
* Balance of Power
* Bollinger Bands
* Chaikin Money Flow
* Chaikin Oscillator
* Chande Momentum Oscillator
* Coppock Curve
* Detrended Price Oscillator
* Donchian Channels
* Ease of Movement
* Envelope
* Exponential Moving Average
* EMA Volume
* Know Sure Thing
* MACD
* Mass Index
* Momentum
* Net Volume
* On Balance Volume
* Price Channel
* Price Oscillator
* Price Volume Trend
* RSI
* Rate of Change
* Relative Vigor Index
* Relative Volatility Index
* Simple Moving Average
* Standard Deviation
* Stochastic
* Stochastic RSI
* TRIX
* True Strength Index
* VWAP
* Volume Oscillator
* Volume Weighted Moving Average
* Weighted Moving Average
* Williams %R

### Installation

```bash
npm i --save bfx-hf-indicators
```

### Quickstart & Example
```js
const { RSI } = require('bfx-hf-indicators')

const rsi = new RSI([14])

rsi.add(14000)
rsi.add(14010)
rsi.add(14025)
rsi.add(14035)
// ...
// 8 more data points
// ...
rsi.add(13998)
rsi.add(13952)

const v = rsi.v() // query current RSI(14) value
```

### Docs

[See `docs/usage.md`](/docs/usage.md) for an overview of the system, and the [`examples/`](/examples) folder for executable examples.

### Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

---
_Source: https://npm.io/package/bfx-hf-indicators · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
