GetPrice

Returns a specific price type for a bar.

Syntax

GetPrice(priceType: TValueType, shift: number): number

Parameters

• priceType: TValueType representing the type of price to return

• shift: A number representing the shift from the current bar

Return Value

Returns a number representing the specified price type for the given bar.

Description

The GetPrice method is a versatile function that returns a specific type of price (Open, High, Low, or Close) for a bar at the specified shift from the current bar. It combines the functionality of individual price methods into a single interface.

See TValueType for available price types:

• OPEN: Opening price of a bar/candle

• HIGH: Highest price of a bar/candle

• LOW: Lowest price of a bar/candle

• CLOSE: Closing price of a bar/candle

• VOLUME: Trading volume of a bar/candle

Example

// Get different price types for current bar
const openPrice = this.api.GetPrice(TValueType.OPEN, 0);
const highPrice = this.api.GetPrice(TValueType.HIGH, 0);
const lowPrice = this.api.GetPrice(TValueType.LOW, 0);
const closePrice = this.api.GetPrice(TValueType.CLOSE, 0);

// Calculate bar range
const barRange =
  this.api.GetPrice(TValueType.HIGH, 0) - this.api.GetPrice(TValueType.LOW, 0);

// Get prices for multiple bars
for (let i = 0; i < 3; i++) {
  const open = this.api.GetPrice(TValueType.OPEN, i);
  const close = this.api.GetPrice(TValueType.CLOSE, i);
  console.log(`Bar -${i}: Open=${open}, Close=${close}`);
}