Candlestick

QuantConnect.Candlestick

Candlestick()

Candlestick(
    time: int,
    open: Optional[float],
    high: Optional[float],
    low: Optional[float],
    close: Optional[float],
)

Candlestick(
    time: Union[datetime, date],
    open: Optional[float],
    high: Optional[float],
    low: Optional[float],
    close: Optional[float],
)

Candlestick(bar: TradeBar)

Candlestick(time: Union[datetime, date], bar: Bar)

Candlestick(candlestick: Candlestick)

Bases: Object, ISeriesPoint

Single candlestick for a candlestick chart

Signature descriptions:

Default constructor
Constructor taking the candlestick values
Constructor taking candlestick values and time in DateTime format
Copy constructor

Parameters:

Name	Type	Description	Default
`time`	`Optional[int \| Union[datetime, date]]`	Candlestick time in seconds since Unix Epoch	`None`
`open`	`Optional[Optional[float]]`	Candlestick open price	`None`
`high`	`Optional[Optional[float]]`	Candlestick high price	`None`
`low`	`Optional[Optional[float]]`	Candlestick low price	`None`
`close`	`Optional[Optional[float]]`	Candlestick close price	`None`
`bar`	`Optional[TradeBar \| Bar]`	Bar which data will be used to create the candlestick	`None`
`candlestick`	`Optional[Candlestick]`	Candlestick to copy from	`None`

time

time: datetime

The candlestick time

long_time

long_time: int

The candlestick time in seconds since Unix Epoch

open

open: Optional[float]

The candlestick open price

high

high: Optional[float]

The candlestick high price

low

low: Optional[float]

The candlestick low price

close

close: Optional[float]

The candlestick close price

update

update(value: Optional[float]) -> None

update(value: float) -> None

Updates the candlestick with a new value. This will aggregate the OHLC bar

Parameters:

Name	Type	Description	Default
`value`	`Optional[float] \| float`	The new value	required

clone

clone() -> ISeriesPoint

Clones this instance

Returns:

Type	Description
`ISeriesPoint`	Clone of this instance.

to_string

to_string() -> str

Provides a readable string representation of this instance.