Candlestick Patterns

Engulfing

Introduction

Create a new Engulfing candlestick pattern to indicate the pattern's presence.

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

Using Engulfing Indicator

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

public class EngulfingAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Engulfing _engulfing;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _engulfing = CandlestickPatterns.Engulfing(_symbol);
    }

    public override void OnData(Slice data)
    {
        if (_engulfing.IsReady)
        {
            // The current value of _engulfing is represented by itself (_engulfing)
            // or _engulfing.Current.Value
            Plot("Engulfing", "engulfing", _engulfing);
            
        }
    }
}
class EngulfingAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.engulfing = self.CandlestickPatterns.Engulfing(self.symbol)

    def OnData(self, slice: Slice) -> None:
        if self.engulfing.IsReady:
            # The current value of self.engulfing is represented by self.engulfing.Current.Value
            self.Plot("Engulfing", "engulfing", self.engulfing.Current.Value)

The following reference table describes the Engulfing method:

Engulfing()1/1

            Engulfing QuantConnect.Algorithm.CandlestickPatterns.Engulfing (
    Symbol                            symbol,
    *Nullable<Resolution>       resolution,
    *Func<IBaseData, TradeBar>  selector
   )

Creates a new Engulfing pattern indicator. The indicator will be automatically updated on the given resolution.

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 Engulfing 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. The indicator will only be ready after you prime it with enough data.

public class EngulfingAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Engulfing _engulfing;

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

    public override void OnData(Slice data)
    {
        if (data.Bars.TryGeValue(_symbol, out var bar))
        {      
            _engulfing.Update(bar);
        }

        if (_engulfing.IsReady)
        {
            // The current value of _engulfing is represented by itself (_engulfing)
            // or _engulfing.Current.Value
            Plot("Engulfing", "engulfing", _engulfing);
            
        }
    }
}
class EngulfingAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.engulfing = Engulfing()

    def OnData(self, slice: Slice) -> None:
        bar = slice.Bars.get(self.symbol)
        if bar:
            self.engulfing.Update(bar)

        if self.engulfing.IsReady:
            # The current value of self.engulfing is represented by self.engulfing.Current.Value
            self.Plot("Engulfing", "engulfing", self.engulfing.Current.Value)

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

public class EngulfingAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Engulfing _engulfing;

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

    public override void OnData(Slice data)
    {
        if (_engulfing.IsReady)
        {
            // The current value of _engulfing is represented by itself (_engulfing)
            // or _engulfing.Current.Value
            Plot("Engulfing", "engulfing", _engulfing);
            
        }
    }
}
class EngulfingAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.engulfing = Engulfing()
        self.RegisterIndicator(self.symbol, self.engulfing, Resolution.Daily)

    def OnData(self, slice: Slice) -> None:
        if self.engulfing.IsReady:
            # The current value of self.engulfing is represented by self.engulfing.Current.Value
            self.Plot("Engulfing", "engulfing", self.engulfing.Current.Value)

The following reference table describes the Engulfing constructor:

Engulfing()1/2

            Engulfing QuantConnect.Indicators.CandlestickPatterns.Engulfing (
    string  name
   )

Initializes a new instance of the Engulfing class using the specified name.

Engulfing()2/2

            Engulfing QuantConnect.Indicators.CandlestickPatterns.Engulfing (
    
   )

Initializes a new instance of the Engulfing class.

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: