Supported Indicators
Heikin Ashi
Introduction
This indicator computes the Heikin-Ashi bar (HA) The Heikin-Ashi bar is calculated using the following formulas: HA_Close[0] = (Open[0] + High[0] + Low[0] + Close[0]) / 4 HA_Open[0] = (HA_Open[1] + HA_Close[1]) / 2 HA_High[0] = MAX(High[0], HA_Open[0], HA_Close[0]) HA_Low[0] = MIN(Low[0], HA_Open[0], HA_Close[0])
To view the implementation of this indicator, see the LEAN GitHub repository.
Using HeikinAshi Indicator
To create an automatic indicators for HeikinAshi
, call the HeikinAshi
helper method from the QCAlgorithm
class. The HeikinAshi
method creates a HeikinAshi
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.
class HeikinAshiAlgorithm(QCAlgorithm): def initialize(self) -> None: self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol self._heikin_ashi = self.heikin_ashi(self._symbol) def on_data(self, slice: Slice) -> None: if self._heikin_ashi.is_ready: # The current value of self._heikin_ashi is represented by self._heikin_ashi.current.value self.plot("HeikinAshi", "heikin_ashi", self._heikin_ashi.current.value) # Plot all attributes of self._heikin_ashi self.plot("HeikinAshi", "open", self._heikin_ashi.open.current.value) self.plot("HeikinAshi", "high", self._heikin_ashi.high.current.value) self.plot("HeikinAshi", "low", self._heikin_ashi.low.current.value) self.plot("HeikinAshi", "close", self._heikin_ashi.close.current.value) self.plot("HeikinAshi", "volume", self._heikin_ashi.volume.current.value)
The following reference table describes the HeikinAshi
method:
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 HeikinAshi
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
or QuoteBar
. The indicator will only be ready after you prime it with enough data.
class HeikinAshiAlgorithm(QCAlgorithm): def initialize(self) -> None: self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol self._heikin_ashi = HeikinAshi() def on_data(self, slice: Slice) -> None: bar = slice.bars.get(self._symbol) if bar: self._heikin_ashi.update(bar) if self._heikin_ashi.is_ready: # The current value of self._heikin_ashi is represented by self._heikin_ashi.current.value self.plot("HeikinAshi", "heikin_ashi", self._heikin_ashi.current.value) # Plot all attributes of self._heikin_ashi self.plot("HeikinAshi", "open", self._heikin_ashi.open.current.value) self.plot("HeikinAshi", "high", self._heikin_ashi.high.current.value) self.plot("HeikinAshi", "low", self._heikin_ashi.low.current.value) self.plot("HeikinAshi", "close", self._heikin_ashi.close.current.value) self.plot("HeikinAshi", "volume", self._heikin_ashi.volume.current.value)
To register a manual indicator for automatic updates with the security data, call the register_indicator
method.
class HeikinAshiAlgorithm(QCAlgorithm): def initialize(self) -> None: self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol self._heikin_ashi = HeikinAshi() self.register_indicator(self._symbol, self._heikin_ashi, Resolution.DAILY) def on_data(self, slice: Slice) -> None: if self._heikin_ashi.is_ready: # The current value of self._heikin_ashi is represented by self._heikin_ashi.current.value self.plot("HeikinAshi", "heikin_ashi", self._heikin_ashi.current.value) # Plot all attributes of self._heikin_ashi self.plot("HeikinAshi", "open", self._heikin_ashi.open.current.value) self.plot("HeikinAshi", "high", self._heikin_ashi.high.current.value) self.plot("HeikinAshi", "low", self._heikin_ashi.low.current.value) self.plot("HeikinAshi", "close", self._heikin_ashi.close.current.value) self.plot("HeikinAshi", "volume", self._heikin_ashi.volume.current.value)
The following reference table describes the HeikinAshi
constructor:
HeikinAshi
This indicator computes the Heikin-Ashi bar (HA) The Heikin-Ashi bar is calculated using the following formulas: HA_Close[0] = (Open[0] + High[0] + Low[0] + Close[0]) / 4 HA_Open[0] = (HA_Open[1] + HA_Close[1]) / 2 HA_High[0] = MAX(High[0], HA_Open[0], HA_Close[0]) HA_Low[0] = MIN(Low[0], HA_Open[0], HA_Close[0])
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
close
Gets the Heikin-Ashi Close
Gets the Heikin-Ashi Close
IndicatorBase[IndicatorDataPoint]
consolidators
The data consolidators associated with this indicator if any
The data consolidators associated with this indicator if any
ISet[IDataConsolidator]
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.
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
high
Gets the Heikin-Ashi High
Gets the Heikin-Ashi High
IndicatorBase[IndicatorDataPoint]
is_ready
Gets a flag indicating when this indicator is ready and fully initialized
Gets a flag indicating when this indicator is ready and fully initialized
bool
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.
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
low
Gets the Heikin-Ashi Low
Gets the Heikin-Ashi Low
IndicatorBase[IndicatorDataPoint]
name
Gets a name for this indicator
Gets a name for this indicator
str
open
Gets the Heikin-Ashi Open
Gets the Heikin-Ashi Open
IndicatorBase[IndicatorDataPoint]
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.
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
samples
Gets the number of samples processed by this indicator
Gets the number of samples processed by this indicator
int
volume
Gets the Heikin-Ashi Volume
Gets the Heikin-Ashi Volume
IndicatorBase[IndicatorDataPoint]
warm_up_period
Required 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
window
A 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]
Visualization
The following image shows plot values of selected properties of HeikinAshi
using the plotly library.

Indicator History
To get the historical data of the HeikinAshi
indicator, call the self.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 indicator_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.
class HeikinAshiAlgorithm(QCAlgorithm): def initialize(self) -> None: self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol heikin_ashi = self.heikin_ashi(self._symbol) count_indicator_history = self.indicator_history(heikin_ashi, self._symbol, 100, Resolution.MINUTE) timedelta_indicator_history = self.indicator_history(heikin_ashi, self._symbol, timedelta(days=10), Resolution.MINUTE) time_period_indicator_history = self.indicator_history(heikin_ashi, self._symbol, datetime(2024, 7, 1), datetime(2024, 7, 5), Resolution.MINUTE)
To make the indicator_history
method update the indicator with an alternative price field instead of the close (or mid-price) of each bar, pass a selector
argument.
indicator_history = self.indicator_history(heikin_ashi, 100, Resolution.MINUTE, lambda bar: bar.high) indicator_history_df = indicator_history.data_frame
To access the properties of the indicator history, index the DataFrame with the property name.
open = indicator_history_df["open"] high = indicator_history_df["high"] low = indicator_history_df["low"] close = indicator_history_df["close"] volume = indicator_history_df["volume"] # Alternative way # open = indicator_history_df.open # high = indicator_history_df.high # low = indicator_history_df.low # close = indicator_history_df.close # volume = indicator_history_df.volume