Class SymbolOHLC

Data class representing OHLC (Open, High, Low, Close) price data for a given symbol.

Index

Properties

candles ftSession ohlcRaw range startOfDay? symbol volRaw

Methods

Properties

candles

candles: [number, number, number, number, number, number][]

A list of parsed OHLC candles in the format: [timestamp_ms, open, high, low, close, volume]

ftSession

ftSession: FTSession

ohlcRaw

ohlcRaw: any[]

range

range: string

`Optional`startOfDay

startOfDay?: number

symbol

symbol: string

volRaw

volRaw: any[]

Methods

`Static`create

create(
    ftSession: FTSession,
    symbol: string,
    range?: string,
): Promise<SymbolOHLC>
Initialize a new instance of the SymbolOHLC class.
Parameters
- ftSession: FTSession
  The session object used for making HTTP requests to Firstrade.
- symbol: string
  The symbol for which OHLC data is retrieved.
- range: string = "1d"
  The time range for the OHLC data (e.g., 24h, 1d, 1w, 1m, 1y).
Returns Promise<SymbolOHLC>
A Promise resolving to a SymbolOHLC instance.

Throws
If the OHLC request fails.

Throws
If the OHLC response contains an error message.
- Defined in src/symbols.ts:186