GetAccountStringProperty

Returns string properties of the trading account.

Syntax

GetAccountStringProperty(propertyId: ENUM_ACCOUNT_INFO_STRING): string

Parameters

• propertyId: An ENUM_ACCOUNT_INFO_STRING value specifying which property to retrieve

Return Value

Returns a string representing the requested account property value.

Description

The GetAccountStringProperty method retrieves string properties of the trading account. Different properties can be accessed using the ENUM_ACCOUNT_INFO_STRING enumeration.

Available properties through ENUM_ACCOUNT_INFO_STRING:

• ACCOUNT_HOLDER_NAME: Account holder's name

• ACCOUNT_BASE_CURRENCY: Account currency

• ACCOUNT_BROKER_NAME: Broker company name

Example

// Get account currency
const currency = this.api.GetAccountStringProperty(
  ENUM_ACCOUNT_INFO_STRING.ACCOUNT_BASE_CURRENCY
);
console.log(`Account Currency: ${currency}`);

// Get broker name
const broker = this.api.GetAccountStringProperty(
  ENUM_ACCOUNT_INFO_STRING.ACCOUNT_BROKER_NAME
);
console.log(`Broker: ${broker}`);

// Get account details
const accountName = this.api.GetAccountStringProperty(
  ENUM_ACCOUNT_INFO_STRING.ACCOUNT_HOLDER_NAME
);
console.log(`Account Name: ${accountName}`);