Indicator Reference

Average Directional Movement Index Rating

Introduction

This indicator computes the Average Directional Movement Index Rating (ADXR). The Average Directional Movement Index Rating is calculated with the following formula: ADXR[i] = (ADX[i] + ADX[i - period + 1]) / 2

Create Manual Indicators

You can manually create a AverageDirectionalMovementIndexRating indicator, so it doesn’t automatically update. Manual indicators let you update their values with any data you choose. The following reference table describes the AverageDirectionalMovementIndexRating constructor.

AverageDirectionalMovementIndexRating()1/2

            AverageDirectionalMovementIndexRating QuantConnect.Indicators.AverageDirectionalMovementIndexRating (
     string  name,
     int     period
   )
        

Initializes a new instance of the AverageDirectionalMovementIndexRating class using the specified name and period.

AverageDirectionalMovementIndexRating()2/2

            AverageDirectionalMovementIndexRating QuantConnect.Indicators.AverageDirectionalMovementIndexRating (
     int  period
   )
        

Initializes a new instance of the AverageDirectionalMovementIndexRating class using the specified period.

Update Manual Indicators

You can update the indicator automatically or manually.

Automatic Update

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


private AverageDirectionalMovementIndexRating _adxr;

// In Initialize()
_adxr = new AverageDirectionalMovementIndexRating(name, period);
_adxr.Updated += IndicatorUpdateMethod;

RegisterIndicator(symbol, _adxr, Resolution.Daily);

// In IndicatorUpdateMethod()
if (_adxr.IsReady)
{
    var indicatorValue = _adxr.Current.Value;
}
    
# In Initialize()
self.adxr = AverageDirectionalMovementIndexRating(name, period)
self.adxr.Updated += self.IndicatorUpdateMethod

self.RegisterIndicator(symbol, self.adxr, Resolution.Daily)

# In IndicatorUpdateMethod()
if self.adxr.IsReady:
    indicator_value = self.adxr.Current.Value

To customize the data that automatically updates the indicator, see Custom Indicator Periods and Custom Indicator Values.

Manual Update

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, QuoteBar, or an IndicatorDataPoint. The indicator will only be ready after you prime it with enough data.

    
private AverageDirectionalMovementIndexRating _adxr;
private Symbol symbol;

// In Initialize()
_adxr = new AverageDirectionalMovementIndexRating(period);
symbol = AddEquity("SPY").Symbol;

// In OnData()
if (data.QuoteBars.ContainsKey(_symbol))
{
    _adxr.Update(data.QuoteBars[symbol]);
}
if (_adxr.IsReady)
{
    var indicatorValue = _adxr.Current.Value;
}
    
# In Initialize()
self.adxr = AverageDirectionalMovementIndexRating(period)
self.symbol = self.AddEquity("SPY").Symbol

# In OnData()
if data.QuoteBars.ContainsKey(self.symbol):
    self.adxr.Update(data.QuoteBars[self.symbol])
if self.adxr.IsReady:
    indicator_value = self.adxr.Current.Value

Create Automatic Indicators

The ADXR method creates an AverageDirectionalMovementIndexRating indicator, sets up a consolidator to update the indicator, and then returns the indicator so you can use it in your algorithm.

The following reference table describes the ADXR method:

ADXR()1/1

            AverageDirectionalMovementIndexRating QuantConnect.Algorithm.QCAlgorithm.ADXR (
    Symbol                                symbol,
    Int32                                 period,
    *Nullable<Resolution>           resolution,
    *Func<IBaseData, IBaseDataBar>  selector
   )
        

Creates a new AverageDirectionalMovementIndexRating indicator.


If you don't provide a resolution, it defauls 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.

Get Indicator Values

To get the value of the indicator, use its Current.Value attribute.

private AverageDirectionalMovementIndexRating _adxr;

// In Initialize()
var symbol = AddEquity("SPY").Symbol;
_adxr = ADXR(symbol, period);

// In OnData()
if (_adxr.IsReady)
{
    var aDX = _adxr.ADX.Current.Value;
    var current = _adxr.Current.Value;
}
# In Initialize()
symbol = self.AddEquity("SPY").Symbol
self.adxr = self.ADXR(symbol, period)

# In OnData()
if self.adxr.IsReady:
    a_d_x = self.adxr.ADX.Current.Value
    current = self.adxr.Current.Value

Visualization

To plot indicator values, in the OnData event handler, call the Plot method.

private AverageDirectionalMovementIndexRating _adxr;

// In Initialize()
var symbol = AddEquity("SPY").Symbol;
_adxr = ADXR(symbol, period);

// In OnData()
if (_adxr.IsReady)
{
    Plot("My Indicators", "adx", _adxr.ADX);
    Plot("My Indicators", "averagedirectionalmovementindexrating", _adxr.Current);
}
# In Initialize()
symbol = self.AddEquity("SPY").Symbol
self.adxr = self.ADXR(symbol, period)

# In OnData()
if self.adxr.IsReady:
    self.Plot("My Indicators", "adx", self.adxr.ADX)
    self.Plot("My Indicators", "averagedirectionalmovementindexrating", self.adxr.Current)

For more information about plotting indicators, see Plotting Indicators.

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: