GetSymbolStringProperty

Returns string properties of a symbol.

Syntax

GetSymbolStringProperty(name: string, prop_id: ENUM_SYMBOL_INFO_STRING): string

Parameters

• name: string - The symbol name

• prop_id: ENUM_SYMBOL_INFO_STRING - The property identifier

Return Value

Returns a string representing the requested symbol property value.

Description

The GetSymbolStringProperty method retrieves text-based properties of a specified symbol. For a complete list of available properties, see ENUM_SYMBOL_INFO_STRING.

Available properties through ENUM_SYMBOL_INFO_STRING:

Example

// Get currency names
const baseCurrency = this.api.GetSymbolStringProperty('EURUSD', ENUM_SYMBOL_INFO_STRING.SYMBOL_BASE_CURRENCY)
const profitCurrency = this.api.GetSymbolStringProperty('EURUSD', ENUM_SYMBOL_INFO_STRING.SYMBOL_PROFIT_CURRENCY)
console.log(`Base Currency: ${baseCurrency}, Profit Currency: ${profitCurrency}`)

// Get symbol description
const description = this.api.GetSymbolStringProperty('EURUSD', ENUM_SYMBOL_INFO_STRING.SYMBOL_DISPLAY_NAME)
console.log(`Symbol Description: ${description}`)