Supported Indicators

Choppiness Index

Introduction

The ChoppinessIndex indicator is an indicator designed to determine if the market is choppy (trading sideways) or not choppy (trading within a trend in either direction)

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

Using CHOP Indicator

To create an automatic indicator for ChoppinessIndex, call the CHOPchop helper method from the QCAlgorithm class. The CHOPchop method creates a ChoppinessIndex 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 Initializeinitialize method.

public class ChoppinessIndexAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private ChoppinessIndex _chop;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _chop = CHOP(_symbol, 14);
    }

    public override void OnData(Slice data)
    {

        if (_chop.IsReady)
        {
            // The current value of _chop is represented by itself (_chop)
            // or _chop.Current.Value
            Plot("ChoppinessIndex", "chop", _chop);
        }
    }
}
class ChoppinessIndexAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        self._chop = self.chop(self._symbol, 14)

    def on_data(self, slice: Slice) -> None:

        if self._chop.is_ready:
            # The current value of self._chop is represented by self._chop.current.value
            self.plot("ChoppinessIndex", "chop", self._chop.current.value)

For more information about this method, see the QCAlgorithm classQCAlgorithm class.

You can manually create a ChoppinessIndex 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 Updateupdate method. The indicator will only be ready after you prime it with enough data.

public class ChoppinessIndexAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private ChoppinessIndex _choppinessindex;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _choppinessindex = new ChoppinessIndex(14);
    }

    public override void OnData(Slice data)
    {
        if (data.Bars.TryGetValue(_symbol, out var bar))
            _choppinessindex.Update(bar);

        if (_choppinessindex.IsReady)
        {
            // The current value of _choppinessindex is represented by itself (_choppinessindex)
            // or _choppinessindex.Current.Value
            Plot("ChoppinessIndex", "choppinessindex", _choppinessindex);
        }
    }
}
class ChoppinessIndexAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        self._choppinessindex = ChoppinessIndex(14)

    def on_data(self, slice: Slice) -> None:
        bar = slice.bars.get(self._symbol)
        if bar:
            self._choppinessindex.update(bar)

        if self._choppinessindex.is_ready:
            # The current value of self._choppinessindex is represented by self._choppinessindex.current.value
            self.plot("ChoppinessIndex", "choppinessindex", self._choppinessindex.current.value)

For more information about this indicator, see its referencereference.

Visualization

The following plot shows values for some of the ChoppinessIndex indicator properties:

ChoppinessIndex line plot.

Indicator History

To get the historical data of the ChoppinessIndex indicator, call the IndicatorHistoryself.indicator_history method. This method resets your indicator, makes a history request, and updates the indicator with the historical data. Just like with regular history requests, the IndicatorHistoryindicator_history method supports time periods based on a trailing number of bars, a trailing period of time, or a defined period of time. If you don't provide a resolution argument, it defaults to match the resolution of the security subscription. 

public class ChoppinessIndexAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private ChoppinessIndex _chop;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _chop = CHOP(_symbol, 14);

        var indicatorHistory = IndicatorHistory(_chop, _symbol, 100, Resolution.Minute);
        var timeSpanIndicatorHistory = IndicatorHistory(_chop, _symbol, TimeSpan.FromDays(10), Resolution.Minute);
        var timePeriodIndicatorHistory = IndicatorHistory(_chop, _symbol, new DateTime(2024, 7, 1), new DateTime(2024, 7, 5), Resolution.Minute);
    }
}
class ChoppinessIndexAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        self._chop = self.chop(self._symbol, 14)

        indicator_history = self.indicator_history(self._chop, self._symbol, 100, Resolution.MINUTE)
        timedelta_indicator_history = self.indicator_history(self._chop, self._symbol, timedelta(days=10), Resolution.MINUTE)
        time_period_indicator_history = self.indicator_history(self._chop, self._symbol, datetime(2024, 7, 1), datetime(2024, 7, 5), Resolution.MINUTE)

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: