Supported Indicators

Arms Index

Introduction

The Arms Index, also called the Short-Term Trading Index (TRIN) is a technical analysis indicator that compares the number of advancing and declining stocks (AD Ratio) to advancing and declining volume (AD volume).

To view the implementation of this indicator, see the LEAN GitHub repository.

Using TRIN Indicator

To create an automatic indicators for ArmsIndex, call the TRIN helper method from the QCAlgorithm class. The TRIN method creates a ArmsIndex object, hooks it up for automatic updates, and returns it so you can used it in your algorithm. In most cases, you should call the helper method in the Initialize method.

public class ArmsIndexAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Symbol _reference;
    private ArmsIndex _trin;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _reference = AddEquity("QQQ", Resolution.Daily).Symbol;
        _trin = TRIN([_symbol, reference]);
    }

    public override void OnData(Slice data)
    {
        if (_trin.IsReady)
        {
            // The current value of _trin is represented by itself (_trin)
            // or _trin.Current.Value
            Plot("ArmsIndex", "trin", _trin);
            // Plot all properties of trin
            Plot("ArmsIndex", "adratio", _trin.ADRatio);
            Plot("ArmsIndex", "advratio", _trin.ADVRatio);
        }
    }
}
class ArmsIndexAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.reference = self.AddEquity("QQQ", Resolution.Daily).Symbol
        self.trin = self.TRIN([self.symbol, reference])

    def OnData(self, slice: Slice) -> None:
        if self.trin.IsReady:
            # The current value of self.trin is represented by self.trin.Current.Value
            self.Plot("ArmsIndex", "trin", self.trin.Current.Value)
            # Plot all attributes of self.trin
            self.Plot("ArmsIndex", "adratio", self.trin.ADRatio.Current.Value)
            self.Plot("ArmsIndex", "advratio", self.trin.ADVRatio.Current.Value)

The following reference table describes the TRIN method:

TRIN()1/2

            ArmsIndex QuantConnect.Algorithm.QCAlgorithm.TRIN (
    IEnumerable<Symbol>         symbols,
    *Nullable<Resolution>       resolution,
    *Func<IBaseData, TradeBar>  selector
   )
        

Creates a new Arms Index indicator.

TRIN()2/2

            ArmsIndex QuantConnect.Algorithm.QCAlgorithm.TRIN (
    Symbol>                        symbols,
    *Nullable<Resolution>       resolution,
    *Func<IBaseData, TradeBar>  selector
   )
        

Creates a new Arms Index indicator.

If you don't provide a resolution, it defaults to the security resolution. If you provide a resolution, it must be greater than or equal to the resolution of the security. For instance, if you subscribe to hourly data for a security, you should update its indicator with data that spans 1 hour or longer.

For more information about the selector argument, see Alternative Price Fields.

For more information about plotting indicators, see Plotting Indicators.

You can manually create a ArmsIndex indicator, so it doesn't automatically update. Manual indicators let you update their values with any data you choose.

Updating your indicator manually enables you to control when the indicator is updated and what data you use to update it. To manually update the indicator, call the Update method with a TradeBar. The indicator will only be ready after you prime it with enough data.

public class ArmsIndexAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Symbol _reference;
    private ArmsIndex _trin;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _reference = AddEquity("QQQ", Resolution.Daily).Symbol;
        _trin = new ArmsIndex("");
    }

    public override void OnData(Slice data)
    {
        if (data.Bars.TryGetValue(_symbol, out var bar))
        {      
            _trin.Update(bar);
        }
        if (data.Bars.TryGetValue(_reference, out bar))
        {      
            _trin.Update(bar);
        }    
    
        if (_trin.IsReady)
        {
            // The current value of _trin is represented by itself (_trin)
            // or _trin.Current.Value
            Plot("ArmsIndex", "trin", _trin);
            // Plot all properties of trin
            Plot("ArmsIndex", "adratio", _trin.ADRatio);
            Plot("ArmsIndex", "advratio", _trin.ADVRatio);
        }
    }
}
class ArmsIndexAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.reference = self.AddEquity("QQQ", Resolution.Daily).Symbol
        self.trin = ArmsIndex("")

    def OnData(self, slice: Slice) -> None:
        bar = slice.Bars.get(self.symbol)
        if bar:
            self.trin.Update(bar)
        bar = slice.Bars.get(self.referece)
        if bar:
            self.trin.Update(bar)
                
        if self.trin.IsReady:
            # The current value of self.trin is represented by self.trin.Current.Value
            self.Plot("ArmsIndex", "trin", self.trin.Current.Value)
            # Plot all attributes of self.trin
            self.Plot("ArmsIndex", "adratio", self.trin.ADRatio.Current.Value)
            self.Plot("ArmsIndex", "advratio", self.trin.ADVRatio.Current.Value)

To register a manual indicator for automatic updates with the security data, call the RegisterIndicator method.

public class ArmsIndexAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Symbol _reference;
    private ArmsIndex _trin;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _reference = AddEquity("QQQ", Resolution.Daily).Symbol;~
        _trin = new ArmsIndex("");
        RegisterIndicator(_symbol, _trin, Resolution.Daily);
        RegisterIndicator(reference, _trin, Resolution.Daily);
    }

    public override void OnData(Slice data)
    {
        if (_trin.IsReady)
        {
            // The current value of _trin is represented by itself (_trin)
            // or _trin.Current.Value
            Plot("ArmsIndex", "trin", _trin);
            // Plot all properties of trin
            Plot("ArmsIndex", "adratio", _trin.ADRatio);
            Plot("ArmsIndex", "advratio", _trin.ADVRatio);
        }
    }
}
class ArmsIndexAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.reference = self.AddEquity("QQQ", Resolution.Daily).Symbol
        self.trin = ArmsIndex("")
        self.RegisterIndicator(self.symbol, self.trin, Resolution.Daily)
        self.RegisterIndicator(reference, self.trin, Resolution.Daily)

    def OnData(self, slice: Slice) -> None:
        if self.trin.IsReady:
            # The current value of self.trin is represented by self.trin.Current.Value
            self.Plot("ArmsIndex", "trin", self.trin.Current.Value)
            # Plot all attributes of self.trin
            self.Plot("ArmsIndex", "adratio", self.trin.ADRatio.Current.Value)
            self.Plot("ArmsIndex", "advratio", self.trin.ADVRatio.Current.Value)

The following reference table describes the ArmsIndex constructor:

ArmsIndex()1/1

            ArmsIndex QuantConnect.Indicators.ArmsIndex (
    
   )
        

Initializes a new instance of the ArmsIndex class.

Visualization

The following image shows plot values of selected properties of ArmsIndex using the plotly library.

ArmsIndex line plot.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: