Supported Indicators

Maximum

Introduction

This indicator represents an indicator capable of tracking the maximum value and how many periods ago it occurred

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

Using MAX Indicator

To create an automatic indicators for Maximum, call the MAX helper method from the QCAlgorithm class. The MAX method creates a Maximum 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 MaximumAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Maximum _max;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _max = MAX(_symbol, 20);
    }

    public override void OnData(Slice data)
    {
        if (_max.IsReady)
        {
            // The current value of _max is represented by itself (_max)
            // or _max.Current.Value
            Plot("Maximum", "max", _max);
            // Plot all properties of max
            Plot("Maximum", "periodssincemaximum", _max.PeriodsSinceMaximum);
        }
    }
}
class MaximumAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        self._max = self.max(self._symbol, 20)

    def on_data(self, slice: Slice) -> None:
        if self._max.is_ready:
            # The current value of self._max is represented by self._max.current.value
            self.plot("Maximum", "max", self._max.current.value)
            # Plot all attributes of self._max
            self.plot("Maximum", "periods_since_maximum", self._max.periods_since_maximum)

The following reference table describes the MAX method:

max(symbol, period, resolution=None, selector=None)[source]

Creates a new Maximum indicator to compute the maximum value

Parameters:
  • symbol (Symbol) — The symbol whose max we want
  • period (int) — The look back period over which to compute the max value
  • resolution (Resolution, optional) — The resolution
  • selector (Callable[IBaseData, float], optional) — x.Value)
Returns:

A Maximum indicator that compute the max value and the periods since the max value

Return type:

Maximum

MAX(symbol, period, resolution=None, selector=None)[source]

Creates a new Maximum indicator to compute the maximum value

Parameters:
  • symbol (Symbol) — The symbol whose max we want
  • period (Int32) — The look back period over which to compute the max value
  • resolution (Resolution, optional) — The resolution
  • selector (Func<IBaseData, Decimal>, optional) — x.Value)
Returns:

A Maximum indicator that compute the max value and the periods since the max value

Return type:

Maximum

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 Maximum 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 with time/number pair or an IndicatorDataPoint. The indicator will only be ready after you prime it with enough data.

public class MaximumAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Maximum _max;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _max = new Maximum(20);
    }

    public override void OnData(Slice data)
    {
        if (data.Bars.TryGetValue(_symbol, out var bar))
        {      
            _max.Update(bar.EndTime, bar.Close);
        }
   
        if (_max.IsReady)
        {
            // The current value of _max is represented by itself (_max)
            // or _max.Current.Value
            Plot("Maximum", "max", _max);
            // Plot all properties of max
            Plot("Maximum", "periodssincemaximum", _max.PeriodsSinceMaximum);
        }
    }
}
class MaximumAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        self._max = Maximum(20)

    def on_data(self, slice: Slice) -> None:
        bar = slice.bars.get(self._symbol)
        if bar:
            self._max.update(bar.EndTime, bar.Close)
        if self._max.is_ready:
            # The current value of self._max is represented by self._max.current.value
            self.plot("Maximum", "max", self._max.current.value)
            # Plot all attributes of self._max
            self.plot("Maximum", "periods_since_maximum", self._max.periods_since_maximum)

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

public class MaximumAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Maximum _max;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _max = new Maximum(20);
        RegisterIndicator(_symbol, _max, Resolution.Daily);
    }

    public override void OnData(Slice data)
    {
        if (_max.IsReady)
        {
            // The current value of _max is represented by itself (_max)
            // or _max.Current.Value
            Plot("Maximum", "max", _max);
            
        }
    }
}
class MaximumAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        self._max = Maximum(20)
        self.register_indicator(self._symbol, self._max, Resolution.DAILY)

    def on_data(self, slice: Slice) -> None:
        if self._max.is_ready:
            # The current value of self._max is represented by self._max.current.value
            self.plot("Maximum", "max", self._max.current.value)

The following reference table describes the Maximum constructor:

Maximum

class QuantConnect.Indicators.Maximum[source]

Represents an indicator capable of tracking the maximum value and how many periods ago it occurred

get_enumerator()

Returns an enumerator that iterates through the history window.

Return type:

IEnumerator[IndicatorDataPoint]

reset()

Resets this indicator to its initial state

to_detailed_string()

Provides a more detailed string of this indicator in the form of {Name} - {Value}

Return type:

str

update(time, value)

Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise

Parameters:
  • time (datetime)
  • value (float)
Return type:

bool

update(input)

Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise

Parameters:
  • input (IBaseData)
Return type:

bool

property consolidators

The data consolidators associated with this indicator if any

Returns:

The data consolidators associated with this indicator if any

Return type:

ISet[IDataConsolidator]

property current

Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Returns:

Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Return type:

IndicatorDataPoint

property is_ready

Gets a flag indicating when this indicator is ready and fully initialized

Returns:

Gets a flag indicating when this indicator is ready and fully initialized

Return type:

bool

property item

Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.

Returns:

Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.

Return type:

IndicatorDataPoint

property name

Gets a name for this indicator

Returns:

Gets a name for this indicator

Return type:

str

property period

Gets the period of this window indicator

Returns:

Gets the period of this window indicator

Return type:

int

property periods_since_maximum

The number of periods since the maximum value was encountered

Returns:

The number of periods since the maximum value was encountered

Return type:

int

property previous

Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Returns:

Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Return type:

IndicatorDataPoint

property samples

Gets the number of samples processed by this indicator

Returns:

Gets the number of samples processed by this indicator

Return type:

int

property warm_up_period

Required period, in data points, for the indicator to be ready and fully initialized.

Returns:

Required period, in data points, for the indicator to be ready and fully initialized.

Return type:

int

property window

A rolling window keeping a history of the indicator values of a given period

Returns:

A rolling window keeping a history of the indicator values of a given period

Return type:

RollingWindow[IndicatorDataPoint]

Maximum

class QuantConnect.Indicators.Maximum[source]

Represents an indicator capable of tracking the maximum value and how many periods ago it occurred

GetEnumerator()

Returns an enumerator that iterates through the history window.

Return type:

IEnumerator[IndicatorDataPoint]

Reset()

Resets this indicator to its initial state

ToDetailedString()

Provides a more detailed string of this indicator in the form of {Name} - {Value}

Return type:

String

Update(time, value)

Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise

Parameters:
  • time (DateTime)
  • value (decimal)
Return type:

Boolean

Update(input)

Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise

Parameters:
  • input (IBaseData)
Return type:

Boolean

property Consolidators

The data consolidators associated with this indicator if any

Returns:

The data consolidators associated with this indicator if any

Return type:

ISet<IDataConsolidator>

property Current

Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Returns:

Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Return type:

IndicatorDataPoint

property IsReady

Gets a flag indicating when this indicator is ready and fully initialized

Returns:

Gets a flag indicating when this indicator is ready and fully initialized

Return type:

bool

property Name

Gets a name for this indicator

Returns:

Gets a name for this indicator

Return type:

string

property Period

Gets the period of this window indicator

Returns:

Gets the period of this window indicator

Return type:

Int32

property PeriodsSinceMaximum

The number of periods since the maximum value was encountered

Returns:

The number of periods since the maximum value was encountered

Return type:

Int32

property Previous

Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Returns:

Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Return type:

IndicatorDataPoint

property Samples

Gets the number of samples processed by this indicator

Returns:

Gets the number of samples processed by this indicator

Return type:

int

property WarmUpPeriod

Required period, in data points, for the indicator to be ready and fully initialized.

Returns:

Required period, in data points, for the indicator to be ready and fully initialized.

Return type:

Int32

property Window

A rolling window keeping a history of the indicator values of a given period

Returns:

A rolling window keeping a history of the indicator values of a given period

Return type:

RollingWindow<IndicatorDataPoint>

property [System.Int32]

Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.

Returns:

Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.

Return type:

IndicatorDataPoint

Visualization

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

Maximum line plot.

Indicator History

To get the historical data of the Maximum 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 MaximumAlgorithm : QCAlgorithm
{
    private Symbol _symbol;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        var max = MAX(_symbol, 20);
        var countIndicatorHistory = IndicatorHistory(max, _symbol, 100, Resolution.Minute);
        var timeSpanIndicatorHistory = IndicatorHistory(max, _symbol, TimeSpan.FromDays(10), Resolution.Minute);
        var timePeriodIndicatorHistory = IndicatorHistory(max, _symbol, new DateTime(2024, 7, 1), new DateTime(2024, 7, 5), Resolution.Minute);
    }
}
class MaximumAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        max = self.max(self._symbol, 20)
        count_indicator_history = self.indicator_history(max, self._symbol, 100, Resolution.MINUTE)
        timedelta_indicator_history = self.indicator_history(max, self._symbol, timedelta(days=10), Resolution.MINUTE)
        time_period_indicator_history = self.indicator_history(max, self._symbol, datetime(2024, 7, 1), datetime(2024, 7, 5), Resolution.MINUTE)

To make the IndicatorHistoryindicator_history method update the indicator with an alternative price field instead of the close (or mid-price) of each bar, pass a selector argument.

var indicatorHistory = IndicatorHistory(max, 100, Resolution.Minute, (bar) => ((TradeBar)bar).High);
indicator_history = self.indicator_history(max, 100, Resolution.MINUTE, lambda bar: bar.high)
indicator_history_df = indicator_history.data_frame

If you already have a list of Slice objects, you can pass them to the IndicatorHistoryindicator_history method to avoid the internal history request.

var history = History(_symbol, 100, Resolution.Minute);
var historyIndicatorHistory = IndicatorHistory(max, history);

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: