Indicator Go

Indicator is a Golang module providing various stock technical analysis indicators, strategies, and a backtest framework for trading.

[!IMPORTANT] I have recently started working on the v2 version. It is a complete rewrite of the library with the following goals:

• Achieving and maintaining minimum of 90% code coverage.
• Having test data in CSV format for each indicator and strategy for easyt validation.
• Operating on data streams (Go channels) for both inputs and outputs.
• Having each indicator and strategy fully configurable with no preset values.
• Supporting all numeric formats using Golang generics.

[!NOTE] I also have a TypeScript version of this module now at Indicator TS.

👆 Indicators Provided

The following list of indicators are currently supported by this package:

📈 Trend Indicators

• Absolute Price Oscillator (APO)
• Aroon Indicator
• Balance of Power (BOP)
• Chande Forecast Oscillator (CFO)
• Community Channel Index (CMI)
• Double Exponential Moving Average (DEMA)
• Exponential Moving Average (EMA)
• Mass Index (MI)
• Moving Average Convergence Divergence (MACD)
• Moving Max
• Moving Min
• Moving Sum
• Parabolic SAR
• Qstick
• Random Index (KDJ)
• Rolling Moving Average (RMA)
• Simple Moving Average (SMA)
• Since Change
• Triple Exponential Moving Average (TEMA)
• Triangular Moving Average (TRIMA)
• Triple Exponential Average (TRIX)
• Typical Price
• Volume Weighted Moving Average (VWMA)
• Vortex Indicator

🚀 Momentum Indicators

• Awesome Oscillator
• Chaikin Oscillator
• Ichimoku Cloud
• Percentage Price Oscillator (PPO)
• Percentage Volume Oscillator (PVO)
• Relative Strength Index (RSI)
• RSI 2
• RSI Period
• Stochastic Oscillator
• Williams R

🎢 Volatility Indicators

• Acceleration Bands
• Actual True Range (ATR)
• Bollinger Band Width
• Bollinger Bands
• Chandelier Exit
• Donchian Channel (DC)
• Keltner Channel (KC)
• Moving Standard Deviation (Std)
• Projection Oscillator (PO)
• Ulcer Index (UI)

📢 Volume Indicators

• Accumulation/Distribution (A/D)
• Chaikin Money Flow (CMF)
• Ease of Movement (EMV)
• Force Index (FI)
• Money Flow Index (MFI)
• Negative Volume Index (NVI)
• On-Balance Volume (OBV)
• Volume Price Trend (VPT)
• Volume Weighted Average Price (VWAP)

🧠 Strategies Provided

Strategies relies on the following:

• Asset
• Action
• Strategy Function
• Buy and Hold Strategy

The following list of strategies are currently supported by this package:

📈 Trend Strategies

• Chande Forecast Oscillator Strategy
• KDJ Strategy
• MACD Strategy
• Trend Strategy
• Volume Weighted Moving Average (VWMA) Strategy

🚀 Momentum Strategies

• Awesome Oscillator Strategy
• RSI Strategy
• RSI 2 Strategy
• Williams R Strategy

🎢 Volatility Strategies

• Bollinger Bands Strategy
• Projection Oscillator Strategy

📢 Volume Strategies

• Chaikin Money Flow Strategy
• Ease of Movement Strategy
• Force Index Strategy
• Money Flow Index Strategy
• Negative Volume Index Strategy
• Volume Weighted Average Price Strategy

🧪 Compound Strategies

• All Strategies
• Run Strategies
• Separate Strategies
• MACD and RSI Strategy

⏳ Backtesting

Backtesting is the method for seeing how well a strategy would have done. The following backtesting functions are provided for evaluating strategies.

• Apply Actions
• Count Transactions
• Normalize Actions
• Normalize Gains

Usage

Install package.

go get github.com/cinar/indicator

Import indicator.

import (
    "github.com/cinar/indicator"
)

Disclaimer

The information provided on this project is strictly for informational purposes and is not to be construed as advice or solicitation to buy or sell any security.

License

The v2.x.x and above are provided under GNU AGPLv3 License.

Copyright (c) 2021-2024 Onur Cinar.    
The source code is provided under GNU AGPLv3 License.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

The version v1.x.x is provided under MIT License.

Copyright (c) 2021-2024 Onur Cinar.
The source code is provided under MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.