exchange-sdk/docs/classes/_candle_.candle.md

@hanzo/matching-engine › Globals › "Candle" › Candle

Class: Candle

candle data

Hierarchy

• Candle

Index

Constructors

• constructor

Properties

• _closeTime
• _openTime
• close
• closeTime
• high
• interval
• low
• open
• openTime
• quoteAssetVolume
• trades
• volume

Methods

• addTrade
• addTradeData
• export
• hasTime

Constructors

constructor

+ new Candle(interval: CandleInterval, t: Trade): Candle

Defined in Candle.ts:143

Parameters:

Name	Type	Description
interval	CandleInterval	candle interval
t	Trade	-

Returns: Candle

Properties

Private _closeTime

• _closeTime: Time

Defined in Candle.ts:103

cached closetime in moment format

---

Private _openTime

• _openTime: Time

Defined in Candle.ts:98

cached opentime in moment format

---

close

• close: Decimal

Defined in Candle.ts:128

close number

---

closeTime

• closeTime: number

Defined in Candle.ts:93

candle close time

---

high

• high: Decimal

Defined in Candle.ts:118

high number

---

interval

• interval: CandleInterval

Defined in Candle.ts:108

candle interval

---

low

• low: Decimal

Defined in Candle.ts:123

low number

---

open

• open: Decimal

Defined in Candle.ts:113

open number

---

openTime

• openTime: number

Defined in Candle.ts:88

candle open time

---

quoteAssetVolume

• quoteAssetVolume: Decimal

Defined in Candle.ts:138

quantity

---

trades

• trades: number

Defined in Candle.ts:143

number of trades

---

volume

• volume: Decimal

Defined in Candle.ts:133

volume in terms of price * quantity

Methods

addTrade

▸ addTrade(t: Trade): this

Defined in Candle.ts:197

add trade to the candle if it is in the correct timeframe

Parameters:

Name	Type
t	Trade

Returns: this

return this to make it chainable or throw error

---

addTradeData

▸ addTradeData(quantity: Decimal, price: Decimal): this

Defined in Candle.ts:175

add just the import trade params to the candle (skips the date check)

Parameters:

Name	Type
quantity	Decimal
price	Decimal

Returns: this

return this to make it chainable

---

export

▸ export(): any[]

Defined in Candle.ts:232

returns exported format based on binance api

example: [ 1499040000000, // Open time 1499644799999, // Close time "0.01634790", // Open "0.80000000", // High "0.01575800", // Low "0.01577100", // Close "148976.11427815", // Volume "2434.19055334", // Quote asset volume 308, // Number of trades ]

Returns: any[]

---

hasTime

▸ hasTime(t: Time | string | number): boolean

Defined in Candle.ts:210

Does the candle interval include this time?

Parameters:

Name	Type
t	Time | string | number

Returns: boolean

true if the time is included in the candle, false otherwise