Candlestick Patterns

Breakaway

Introduction

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

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

Using Breakaway Indicator

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

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

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

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

The following reference table describes the Breakaway method:

Breakaway()1/1

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

Creates a new Breakaway 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 Breakaway 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 BreakawayAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Breakaway _breakaway;

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

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

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

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

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

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

public class BreakawayAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private Breakaway _breakaway;

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

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

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

The following reference table describes the Breakaway constructor:

Breakaway()1/2

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

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

Breakaway()2/2

            Breakaway QuantConnect.Indicators.CandlestickPatterns.Breakaway (
    
   )

Initializes a new instance of the Breakaway 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: