Table of Contents

Struct Candle

Namespace
WhalesSecret.TradeScriptLib.Entities.MarketData
Assembly
WhalesSecret.TradeScriptLib.dll

Description of a candlestick.

[JsonConverter(typeof(CandleConverter))]
public struct Candle : IEquatable<Candle>
Implements
Inherited Members
Extension Methods

Constructors

Candle(DateTime, decimal, decimal, decimal, decimal, decimal, decimal, bool)

Creates a new instance of the object.

Fields

TimeFormat

Time format for ToString().

Properties

BaseVolume

Trading volume in base symbol since Timestamp.

ClosePrice

Close price in decimal format.

HighPrice

High price in decimal format.

IsClosed

Whether or not the candle is closed.

A closed candle is information about a historical fact with all the values in their final, unchangeable, state. On the other hand, an open candle is information about the state at some moment of time and if the same candle information is queried in the future, different values of HighPrice, LowPrice, ClosePrice, BaseVolume, and/or QuoteVolume may be reported.

IsEmpty

true if the candle is "empty", false otherwise. Empty candle is not a real candle, it is a dummy placeholder for a candle which we are missing.

LowPrice

Low price in decimal format.

OpenPrice

Open price in decimal format.

QuoteVolume

Trading amount in quote symbol since Timestamp.

Timestamp

UTC timestamp of the candle.

Methods

Clone(bool?)

Creates a clone of the candle with a possibility to define whether the clone is open or closed.

CreateEmpty(DateTime, decimal, bool)

Creates an empty candle with the given timestamp.

Equals(object?)

Indicates whether this instance and a specified object are equal.

Equals(Candle)

Indicates whether the current object is equal to another object of the same type.

GetHashCode()

Returns the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

Operators

operator ==(Candle, Candle)

Determines whether two candles have the same values.

operator !=(Candle, Candle)

Determines whether two candles have different values.

See Also