CandlestickPatterns

QuantConnect.Algorithm.CandlestickPatterns

CandlestickPatterns(algorithm: QCAlgorithm)

Bases: Object

Provides helpers for using candlestick patterns

Initializes a new instance of the CandlestickPatterns class

Parameters:

Name	Type	Description	Default
algorithm	QCAlgorithm	The algorithm instance	required

abandoned_baby

abandoned_baby(
    symbol: Union[Symbol, str, BaseContract],
    penetration: float = 0.3,
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> AbandonedBaby

Creates a new Indicators.CandlestickPatterns.AbandonedBaby pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
penetration	float	Percentage of penetration of a candle within another candle	0.3
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
AbandonedBaby	The pattern indicator for the requested symbol.

advance_block

advance_block(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> AdvanceBlock

Creates a new Indicators.CandlestickPatterns.AdvanceBlock pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
AdvanceBlock	The pattern indicator for the requested symbol.

belt_hold

belt_hold(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> BeltHold

Creates a new Indicators.CandlestickPatterns.BeltHold pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
BeltHold	The pattern indicator for the requested symbol.

breakaway

breakaway(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Breakaway

Creates a new Indicators.CandlestickPatterns.Breakaway pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Breakaway	The pattern indicator for the requested symbol.

closing_marubozu

closing_marubozu(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ClosingMarubozu

Creates a new Indicators.CandlestickPatterns.ClosingMarubozu pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ClosingMarubozu	The pattern indicator for the requested symbol.

concealed_baby_swallow

concealed_baby_swallow(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ConcealedBabySwallow

Creates a new Indicators.CandlestickPatterns.ConcealedBabySwallow pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ConcealedBabySwallow	The pattern indicator for the requested symbol.

counterattack

counterattack(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Counterattack

Creates a new Indicators.CandlestickPatterns.Counterattack pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Counterattack	The pattern indicator for the requested symbol.

dark_cloud_cover

dark_cloud_cover(
    symbol: Union[Symbol, str, BaseContract],
    penetration: float = 0.5,
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> DarkCloudCover

Creates a new Indicators.CandlestickPatterns.DarkCloudCover pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
penetration	float	Percentage of penetration of a candle within another candle	0.5
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
DarkCloudCover	The pattern indicator for the requested symbol.

doji

doji(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Doji

Creates a new Indicators.CandlestickPatterns.Doji pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Doji	The pattern indicator for the requested symbol.

doji_star

doji_star(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> DojiStar

Creates a new Indicators.CandlestickPatterns.DojiStar pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
DojiStar	The pattern indicator for the requested symbol.

dragonfly_doji

dragonfly_doji(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> DragonflyDoji

Creates a new Indicators.CandlestickPatterns.DragonflyDoji pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
DragonflyDoji	The pattern indicator for the requested symbol.

engulfing

engulfing(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Engulfing

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

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Engulfing	The pattern indicator for the requested symbol.

evening_doji_star

evening_doji_star(
    symbol: Union[Symbol, str, BaseContract],
    penetration: float = 0.3,
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> EveningDojiStar

Creates a new Indicators.CandlestickPatterns.EveningDojiStar pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
penetration	float	Percentage of penetration of a candle within another candle	0.3
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
EveningDojiStar	The pattern indicator for the requested symbol.

evening_star

evening_star(
    symbol: Union[Symbol, str, BaseContract],
    penetration: float = 0.3,
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> EveningStar

Creates a new Indicators.CandlestickPatterns.EveningStar pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
penetration	float	Percentage of penetration of a candle within another candle	0.3
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
EveningStar	The pattern indicator for the requested symbol.

gap_side_by_side_white

gap_side_by_side_white(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> GapSideBySideWhite

Creates a new Indicators.CandlestickPatterns.GapSideBySideWhite pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
GapSideBySideWhite	The pattern indicator for the requested symbol.

gravestone_doji

gravestone_doji(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> GravestoneDoji

Creates a new Indicators.CandlestickPatterns.GravestoneDoji pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
GravestoneDoji	The pattern indicator for the requested symbol.

hammer

hammer(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Hammer

Creates a new Indicators.CandlestickPatterns.Hammer pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Hammer	The pattern indicator for the requested symbol.

hanging_man

hanging_man(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> HangingMan

Creates a new Indicators.CandlestickPatterns.HangingMan pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
HangingMan	The pattern indicator for the requested symbol.

harami

harami(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Harami

Creates a new Indicators.CandlestickPatterns.Harami pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Harami	The pattern indicator for the requested symbol.

harami_cross

harami_cross(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> HaramiCross

Creates a new Indicators.CandlestickPatterns.HaramiCross pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
HaramiCross	The pattern indicator for the requested symbol.

high_wave_candle

high_wave_candle(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> HighWaveCandle

Creates a new Indicators.CandlestickPatterns.HighWaveCandle pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
HighWaveCandle	The pattern indicator for the requested symbol.

hikkake

hikkake(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Hikkake

Creates a new Indicators.CandlestickPatterns.Hikkake pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Hikkake	The pattern indicator for the requested symbol.

hikkake_modified

hikkake_modified(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> HikkakeModified

Creates a new Indicators.CandlestickPatterns.HikkakeModified pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
HikkakeModified	The pattern indicator for the requested symbol.

homing_pigeon

homing_pigeon(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> HomingPigeon

Creates a new Indicators.CandlestickPatterns.HomingPigeon pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
HomingPigeon	The pattern indicator for the requested symbol.

identical_three_crows

identical_three_crows(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> IdenticalThreeCrows

Creates a new Indicators.CandlestickPatterns.IdenticalThreeCrows pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
IdenticalThreeCrows	The pattern indicator for the requested symbol.

in_neck

in_neck(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> InNeck

Creates a new Indicators.CandlestickPatterns.InNeck pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
InNeck	The pattern indicator for the requested symbol.

inverted_hammer

inverted_hammer(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> InvertedHammer

Creates a new Indicators.CandlestickPatterns.InvertedHammer pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
InvertedHammer	The pattern indicator for the requested symbol.

kicking

kicking(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Kicking

Creates a new Indicators.CandlestickPatterns.Kicking pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Kicking	The pattern indicator for the requested symbol.

kicking_by_length

kicking_by_length(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> KickingByLength

Creates a new Indicators.CandlestickPatterns.KickingByLength pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
KickingByLength	The pattern indicator for the requested symbol.

ladder_bottom

ladder_bottom(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> LadderBottom

Creates a new Indicators.CandlestickPatterns.LadderBottom pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
LadderBottom	The pattern indicator for the requested symbol.

long_legged_doji

long_legged_doji(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> LongLeggedDoji

Creates a new Indicators.CandlestickPatterns.LongLeggedDoji pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
LongLeggedDoji	The pattern indicator for the requested symbol.

long_line_candle

long_line_candle(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> LongLineCandle

Creates a new Indicators.CandlestickPatterns.LongLineCandle pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
LongLineCandle	The pattern indicator for the requested symbol.

marubozu

marubozu(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Marubozu

Creates a new Indicators.CandlestickPatterns.Marubozu pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Marubozu	The pattern indicator for the requested symbol.

matching_low

matching_low(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> MatchingLow

Creates a new Indicators.CandlestickPatterns.MatchingLow pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
MatchingLow	The pattern indicator for the requested symbol.

mat_hold

mat_hold(
    symbol: Union[Symbol, str, BaseContract],
    penetration: float = 0.5,
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> MatHold

Creates a new Indicators.CandlestickPatterns.MatHold pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
penetration	float	Percentage of penetration of a candle within another candle	0.5
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
MatHold	The pattern indicator for the requested symbol.

morning_doji_star

morning_doji_star(
    symbol: Union[Symbol, str, BaseContract],
    penetration: float = 0.3,
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> MorningDojiStar

Creates a new Indicators.CandlestickPatterns.MorningDojiStar pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
penetration	float	Percentage of penetration of a candle within another candle	0.3
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
MorningDojiStar	The pattern indicator for the requested symbol.

morning_star

morning_star(
    symbol: Union[Symbol, str, BaseContract],
    penetration: float = 0.3,
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> MorningStar

Creates a new Indicators.CandlestickPatterns.MorningStar pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
penetration	float	Percentage of penetration of a candle within another candle	0.3
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
MorningStar	The pattern indicator for the requested symbol.

on_neck

on_neck(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> OnNeck

Creates a new Indicators.CandlestickPatterns.OnNeck pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
OnNeck	The pattern indicator for the requested symbol.

piercing

piercing(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Piercing

Creates a new Indicators.CandlestickPatterns.Piercing pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Piercing	The pattern indicator for the requested symbol.

rickshaw_man

rickshaw_man(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> RickshawMan

Creates a new Indicators.CandlestickPatterns.RickshawMan pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
RickshawMan	The pattern indicator for the requested symbol.

rise_fall_three_methods

rise_fall_three_methods(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> RiseFallThreeMethods

Creates a new Indicators.CandlestickPatterns.RiseFallThreeMethods pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
RiseFallThreeMethods	The pattern indicator for the requested symbol.

separating_lines

separating_lines(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> SeparatingLines

Creates a new Indicators.CandlestickPatterns.SeparatingLines pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
SeparatingLines	The pattern indicator for the requested symbol.

shooting_star

shooting_star(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ShootingStar

Creates a new Indicators.CandlestickPatterns.ShootingStar pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ShootingStar	The pattern indicator for the requested symbol.

short_line_candle

short_line_candle(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ShortLineCandle

Creates a new Indicators.CandlestickPatterns.ShortLineCandle pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ShortLineCandle	The pattern indicator for the requested symbol.

spinning_top

spinning_top(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> SpinningTop

Creates a new Indicators.CandlestickPatterns.SpinningTop pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
SpinningTop	The pattern indicator for the requested symbol.

stalled_pattern

stalled_pattern(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> StalledPattern

Creates a new Indicators.CandlestickPatterns.StalledPattern pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
StalledPattern	The pattern indicator for the requested symbol.

stick_sandwich

stick_sandwich(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> StickSandwich

Creates a new Indicators.CandlestickPatterns.StickSandwich pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
StickSandwich	The pattern indicator for the requested symbol.

takuri

takuri(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Takuri

Creates a new Indicators.CandlestickPatterns.Takuri pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Takuri	The pattern indicator for the requested symbol.

tasuki_gap

tasuki_gap(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> TasukiGap

Creates a new Indicators.CandlestickPatterns.TasukiGap pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
TasukiGap	The pattern indicator for the requested symbol.

three_black_crows

three_black_crows(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ThreeBlackCrows

Creates a new Indicators.CandlestickPatterns.ThreeBlackCrows pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ThreeBlackCrows	The pattern indicator for the requested symbol.

three_inside

three_inside(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ThreeInside

Creates a new Indicators.CandlestickPatterns.ThreeInside pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ThreeInside	The pattern indicator for the requested symbol.

three_line_strike

three_line_strike(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ThreeLineStrike

Creates a new Indicators.CandlestickPatterns.ThreeLineStrike pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ThreeLineStrike	The pattern indicator for the requested symbol.

three_outside

three_outside(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ThreeOutside

Creates a new Indicators.CandlestickPatterns.ThreeOutside pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ThreeOutside	The pattern indicator for the requested symbol.

three_stars_in_south

three_stars_in_south(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ThreeStarsInSouth

Creates a new Indicators.CandlestickPatterns.ThreeStarsInSouth pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ThreeStarsInSouth	The pattern indicator for the requested symbol.

three_white_soldiers

three_white_soldiers(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> ThreeWhiteSoldiers

Creates a new Indicators.CandlestickPatterns.ThreeWhiteSoldiers pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
ThreeWhiteSoldiers	The pattern indicator for the requested symbol.

thrusting

thrusting(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Thrusting

Creates a new Indicators.CandlestickPatterns.Thrusting pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Thrusting	The pattern indicator for the requested symbol.

tristar

tristar(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> Tristar

Creates a new Indicators.CandlestickPatterns.Tristar pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
Tristar	The pattern indicator for the requested symbol.

two_crows

two_crows(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> TwoCrows

Creates a new Indicators.CandlestickPatterns.TwoCrows pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
TwoCrows	The pattern indicator for the requested symbol.

unique_three_river

unique_three_river(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> UniqueThreeRiver

Creates a new Indicators.CandlestickPatterns.UniqueThreeRiver pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
UniqueThreeRiver	The pattern indicator for the requested symbol.

up_down_gap_three_methods

up_down_gap_three_methods(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> UpDownGapThreeMethods

Creates a new Indicators.CandlestickPatterns.UpDownGapThreeMethods pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
UpDownGapThreeMethods	The pattern indicator for the requested symbol.

upside_gap_two_crows

upside_gap_two_crows(
    symbol: Union[Symbol, str, BaseContract],
    resolution: Optional[Resolution] = None,
    selector: Callable[[IBaseData], IBaseDataBar] = None,
) -> UpsideGapTwoCrows

Creates a new Indicators.CandlestickPatterns.UpsideGapTwoCrows pattern indicator. The indicator will be automatically updated on the given resolution.

Parameters:

Name	Type	Description	Default
symbol	Union[Symbol, str, BaseContract]	The symbol whose pattern we seek	required
resolution	Optional[Resolution]	The resolution.	None
selector	Callable[[IBaseData], IBaseDataBar]	Selects a value from the BaseData to send into the indicator, if null defaults to casting the input value to a TradeBar	None

Returns:

Type	Description
UpsideGapTwoCrows	The pattern indicator for the requested symbol.