Supported Indicators
Mc Clellan Summation Index
Introduction
The McClellan Summation Index (MSI) is a market breadth indicator that is based on the rolling average of difference between the number of advancing and declining issues on a stock exchange. It is generally considered as is a long-term version of the
To view the implementation of this indicator, see the LEAN GitHub repository.
Using MSI Indicator
To create an automatic indicators for McClellanSummationIndex, call the MSI helper method from the QCAlgorithm class. The MSI method creates a McClellanSummationIndex 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 McClellanSummationIndexAlgorithm : QCAlgorithm
{
private Symbol _symbol;
private Symbol _reference;
private McClellanSummationIndex _msi;
public override void Initialize()
{
_symbol = AddEquity("SPY", Resolution.Daily).Symbol;
_reference = AddEquity("QQQ", Resolution.Daily).Symbol;
_msi = MSI([_symbol, reference]);
}
public override void OnData(Slice data)
{
if (_msi.IsReady)
{
// The current value of _msi is represented by itself (_msi)
// or _msi.Current.Value
Plot("McClellanSummationIndex", "msi", _msi);
// Plot all properties of msi
Plot("McClellanSummationIndex", "mcclellanoscillator", _msi.McClellanOscillator);
}
}
} class McClellanSummationIndexAlgorithm(QCAlgorithm):
def initialize(self) -> None:
self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
self.reference = self.add_equity("QQQ", Resolution.DAILY).symbol
self._msi = self.msi([self._symbol, reference])
def on_data(self, slice: Slice) -> None:
if self._msi.is_ready:
# The current value of self._msi is represented by self._msi.current.value
self.plot("McClellanSummationIndex", "msi", self._msi.current.value)
# Plot all attributes of self._msi
self.plot("McClellanSummationIndex", "mc_clellan_oscillator", self._msi.mc_clellan_oscillator.current.value)
The following reference table describes the MSI method:
msi(symbols, fast_period=19, slow_period=39, resolution=None, selector=None)[source]Creates a new McClellan Summation Index indicator
- symbols (List[Symbol] | Symbol[]) — The symbols whose McClellan Summation Index we want
- fast_period (int, optional) — Fast period EMA of advance decline difference
- slow_period (int, optional) — Slow period EMA of advance decline difference
- resolution (Resolution, optional) — The resolution
- selector (Callable[IBaseData, TradeBar], optional) — Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar
The McClellan Summation Index indicator for the requested symbol over the specified period
MSI(symbols, fastPeriod=19, slowPeriod=39, resolution=None, selector=None)[source]Creates a new McClellan Summation Index indicator
- symbols (Symbol[] | IEnumerable[Symbol]) — The symbols whose McClellan Summation Index we want
- fastPeriod (Int32, optional) — Fast period EMA of advance decline difference
- slowPeriod (Int32, optional) — Slow period EMA of advance decline difference
- resolution (Resolution, optional) — The resolution
- selector (Func<IBaseData, TradeBar>, optional) — Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar
The McClellan Summation Index indicator for the requested symbol over the specified period
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 McClellanSummationIndex 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 a TradeBar. The indicator will only be ready after you prime it with enough data.
public class McClellanSummationIndexAlgorithm : QCAlgorithm
{
private Symbol _symbol;
private Symbol _reference;
private McClellanSummationIndex _msi;
public override void Initialize()
{
_symbol = AddEquity("SPY", Resolution.Daily).Symbol;
_reference = AddEquity("QQQ", Resolution.Daily).Symbol;
_msi = new McClellanSummationIndex("");
}
public override void OnData(Slice data)
{
if (data.Bars.TryGetValue(_symbol, out var bar))
{
_msi.Update(bar);
}
if (data.Bars.TryGetValue(_reference, out bar))
{
_msi.Update(bar);
}
if (_msi.IsReady)
{
// The current value of _msi is represented by itself (_msi)
// or _msi.Current.Value
Plot("McClellanSummationIndex", "msi", _msi);
// Plot all properties of msi
Plot("McClellanSummationIndex", "mcclellanoscillator", _msi.McClellanOscillator);
}
}
} class McClellanSummationIndexAlgorithm(QCAlgorithm):
def initialize(self) -> None:
self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
self.reference = self.add_equity("QQQ", Resolution.DAILY).symbol
self._msi = McClellanSummationIndex("")
def on_data(self, slice: Slice) -> None:
bar = slice.bars.get(self._symbol)
if bar:
self._msi.update(bar)
bar = slice.bars.get(self.referece)
if bar:
self._msi.update(bar)
if self._msi.is_ready:
# The current value of self._msi is represented by self._msi.current.value
self.plot("McClellanSummationIndex", "msi", self._msi.current.value)
# Plot all attributes of self._msi
self.plot("McClellanSummationIndex", "mc_clellan_oscillator", self._msi.mc_clellan_oscillator.current.value)
To register a manual indicator for automatic updates with the security data, call the RegisterIndicatorregister_indicator method.
public class McClellanSummationIndexAlgorithm : QCAlgorithm
{
private Symbol _symbol;
private Symbol _reference;
private McClellanSummationIndex _msi;
public override void Initialize()
{
_symbol = AddEquity("SPY", Resolution.Daily).Symbol;
_reference = AddEquity("QQQ", Resolution.Daily).Symbol;
_msi = new McClellanSummationIndex("");
RegisterIndicator(_symbol, _msi, Resolution.Daily);
RegisterIndicator(reference, _msi, Resolution.Daily);
}
public override void OnData(Slice data)
{
if (_msi.IsReady)
{
// The current value of _msi is represented by itself (_msi)
// or _msi.Current.Value
Plot("McClellanSummationIndex", "msi", _msi);
// Plot all properties of msi
Plot("McClellanSummationIndex", "mcclellanoscillator", _msi.McClellanOscillator);
}
}
} class McClellanSummationIndexAlgorithm(QCAlgorithm):
def initialize(self) -> None:
self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
self.reference = self.add_equity("QQQ", Resolution.DAILY).symbol
self._msi = McClellanSummationIndex("")
self.register_indicator(self._symbol, self._msi, Resolution.DAILY)
self.register_indicator(reference, self._msi, Resolution.DAILY)
def on_data(self, slice: Slice) -> None:
if self._msi.is_ready:
# The current value of self._msi is represented by self._msi.current.value
self.plot("McClellanSummationIndex", "msi", self._msi.current.value)
# Plot all attributes of self._msi
self.plot("McClellanSummationIndex", "mc_clellan_oscillator", self._msi.mc_clellan_oscillator.current.value)
The following reference table describes the McClellanSummationIndex constructor:
McClellanSummationIndex
The McClellan Summation Index (MSI) is a market breadth indicator that is based on the rolling average of difference between the number of advancing and declining issues on a stock exchange. It is generally considered as is a long-term version of the McClellanOscillator
get_enumerator()Returns an enumerator that iterates through the history window.
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}
str
update(time, value)Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise
- time (datetime)
- value (float)
bool
update(input)Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise
- input (IBaseData)
bool
consolidatorsThe data consolidators associated with this indicator if any
The data consolidators associated with this indicator if any
ISet[IDataConsolidator]
currentGets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
IndicatorDataPoint
is_readyGets a flag indicating when this indicator is ready and fully initialized
Gets a flag indicating when this indicator is ready and fully initialized
bool
itemIndexes 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.
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.
IndicatorDataPoint
mc_clellan_oscillatorThe McClellan Oscillator is a market breadth indicator which was developed by Sherman and Marian McClellan. It is based on the difference between the number of advancing and declining periods.
The McClellan Oscillator is a market breadth indicator which was developed by Sherman and Marian McClellan. It is based on the difference between the number of advancing and declining periods.
McClellanOscillator
nameGets a name for this indicator
Gets a name for this indicator
str
previousGets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
IndicatorDataPoint
samplesGets the number of samples processed by this indicator
Gets the number of samples processed by this indicator
int
warm_up_periodRequired period, in data points, for the indicator to be ready and fully initialized.
Required period, in data points, for the indicator to be ready and fully initialized.
int
windowA rolling window keeping a history of the indicator values of a given period
A rolling window keeping a history of the indicator values of a given period
RollingWindow[IndicatorDataPoint]
McClellanSummationIndex
The McClellan Summation Index (MSI) is a market breadth indicator that is based on the rolling average of difference between the number of advancing and declining issues on a stock exchange. It is generally considered as is a long-term version of the McClellanOscillator
GetEnumerator()Returns an enumerator that iterates through the history window.
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}
String
Update(time, value)Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise
- time (DateTime)
- value (decimal)
Boolean
Update(input)Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise
- input (IBaseData)
Boolean
ConsolidatorsThe data consolidators associated with this indicator if any
The data consolidators associated with this indicator if any
ISet<IDataConsolidator>
CurrentGets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
IndicatorDataPoint
IsReadyGets a flag indicating when this indicator is ready and fully initialized
Gets a flag indicating when this indicator is ready and fully initialized
bool
McClellanOscillatorThe McClellan Oscillator is a market breadth indicator which was developed by Sherman and Marian McClellan. It is based on the difference between the number of advancing and declining periods.
The McClellan Oscillator is a market breadth indicator which was developed by Sherman and Marian McClellan. It is based on the difference between the number of advancing and declining periods.
McClellanOscillator
NameGets a name for this indicator
Gets a name for this indicator
string
PreviousGets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
IndicatorDataPoint
SamplesGets the number of samples processed by this indicator
Gets the number of samples processed by this indicator
int
WarmUpPeriodRequired period, in data points, for the indicator to be ready and fully initialized.
Required period, in data points, for the indicator to be ready and fully initialized.
Int32
WindowA rolling window keeping a history of the indicator values of a given period
A rolling window keeping a history of the indicator values of a given period
RollingWindow<IndicatorDataPoint>
[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.
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.
IndicatorDataPoint
Visualization
The following image shows plot values of selected properties of McClellanSummationIndex using the plotly library.
Indicator History
To get the historical data of the McClellanSummationIndex 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 McClellanSummationIndexAlgorithm : QCAlgorithm
{
private Symbol _symbol;
private Symbol _reference;
public override void Initialize()
{
_symbol = AddEquity("SPY", Resolution.Daily).Symbol;
_reference = AddEquity("QQQ", Resolution.Daily).Symbol;
var msi = MSI([_symbol, reference]);
var countIndicatorHistory = IndicatorHistory(msi, new[] { _symbol, _reference }, 100, Resolution.Minute);
var timeSpanIndicatorHistory = IndicatorHistory(msi, new[] { _symbol, _reference }, TimeSpan.FromDays(10), Resolution.Minute);
var timePeriodIndicatorHistory = IndicatorHistory(msi, new[] { _symbol, _reference }, new DateTime(2024, 7, 1), new DateTime(2024, 7, 5), Resolution.Minute);
}
} class McClellanSummationIndexAlgorithm(QCAlgorithm):
def initialize(self) -> None:
self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
self._reference = self.add_equity("QQQ", Resolution.DAILY).symbol
msi = self.msi([self._symbol, reference])
count_indicator_history = self.indicator_history(msi, [self._symbol, self._reference], 100, Resolution.MINUTE)
timedelta_indicator_history = self.indicator_history(msi, [self._symbol, self._reference], timedelta(days=10), Resolution.MINUTE)
time_period_indicator_history = self.indicator_history(msi, [self._symbol, self._reference], 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(msi, 100, Resolution.Minute, (bar) => ((TradeBar)bar).High);
indicator_history = self.indicator_history(msi, 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(new[] { _symbol, _reference }, 100, Resolution.Minute);
var historyIndicatorHistory = IndicatorHistory(msi, history);
To access the properties of the indicator history, invoke the property of each IndicatorDataPoint object.index the DataFrame with the property name.
var mcclellanoscillator = indicatorHistory.Select(x => ((dynamic)x).McClellanOscillator).ToList(); // Alternative way // var mcclellanoscillator = indicatorHistory.Select(x => x["mcclellanoscillator"]).ToList();
mc_clellan_oscillator = indicator_history_df["mc_clellan_oscillator"] # Alternative way # mc_clellan_oscillator = indicator_history_df.mc_clellan_oscillator
You can also see our Videos. You can also get in touch with us via Discord.
Did you find this page helpful?
