Point

Returns the minimum price change (point) value.

Syntax

Point(): number

Return Value

Returns a number representing the minimum price change value.

Description

The Point method returns the minimum price change value for the symbol. This is the smallest price movement possible and is used as a base for various calculations.

Example

// Get point value
const point = this.api.Point();
console.log(`Point value: ${point}`);

// Calculate spread in points
const spreadPoints = (this.api.Ask() - this.api.Bid()) / this.api.Point();
console.log(`Spread in points: ${spreadPoints}`);

// Calculate price movement
const priceChange = (currentPrice - previousPrice) / this.api.Point();
console.log(`Price moved ${priceChange} points`);