GetAccountNumberProperty

Returns numeric properties of the trading account.

Syntax

GetAccountNumberProperty(propertyId: ENUM_ACCOUNT_INFO_NUMBER): number

Parameters

• propertyId: An ENUM_ACCOUNT_INFO_NUMBER value specifying which property to retrieve

Return Value

Returns a number representing the requested account property value.

Description

The GetAccountNumberProperty method retrieves numeric properties of the trading account. Different properties can be accessed using the ENUM_ACCOUNT_INFO_NUMBER enumeration.

Available properties through ENUM_ACCOUNT_INFO_NUMBER:

• ACCOUNT_LEVERAGE_RATIO: Account leverage ratio

• ACCOUNT_BALANCE_CURRENT: Current account balance

• ACCOUNT_CURRENT_PROFIT: Current profit

• ACCOUNT_EQUITY_CURRENT: Current equity

• ACCOUNT_MARGIN_USED: Margin used

• ACCOUNT_MARGIN_AVAILABLE: Available margin

Example

// Get account balance
const balance = this.api.GetAccountNumberProperty(
  ENUM_ACCOUNT_INFO_NUMBER.ACCOUNT_BALANCE_CURRENT
);
console.log(`Balance: ${balance}`);

// Get current profit
const profit = this.api.GetAccountNumberProperty(
  ENUM_ACCOUNT_INFO_NUMBER.ACCOUNT_CURRENT_PROFIT
);
console.log(`Current Profit: ${profit}`);

// Check leverage
const leverage = this.api.GetAccountNumberProperty(
  ENUM_ACCOUNT_INFO_NUMBER.ACCOUNT_LEVERAGE_RATIO
);
console.log(`Account Leverage: ${leverage}:1`);