Symbol functions are mostly used for accessing the strategy's symbols and their properties. Each strategy in the Desktop has its own separate symbols table which it uses to hold all of its symbols. 


Sections


Functions

Function Details


Functions


Name

Description

string SymbolBaseCurrencyCode()

Gets the base currency code of the underlying forex symbol, i.e. the first currency in the pair.

string SymbolBaseCurrencyCode(int, int)

Gets the base currency code of a specified forex symbol, i.e. the first currency in the pair.

int SymbolContractMonth()

Gets the contract month of the underlying futures symbol.

int SymbolContractMonth(int, int)

Gets the contract month of a specified futures symbol.

int SymbolContractYear()

Gets the contract year of the underlying futures symbol.

int SymbolContractYear(int, int)

Gets the contract year of a specified futures symbol.

int SymbolCount()

Gets the number of symbols in the symbols table.

int SymbolCount(int)

Gets the number of symbols in the symbols table of a specified strategy.

string SymbolCurrencyCode()

Gets the currency code of the underlying symbol (the second currency code in a forex pair).

string SymbolCurrencyCode(int, int)

Gets the currency code of a specified symbol (the second currency code in a forex pair).

int SymbolDecimals()

Gets the number of decimals in the tick/pip of the underlying symbol.

int SymbolDecimals(int, int)

Gets the number of decimals in the tick/pip of a specified symbol.

long SymbolEndDate()

Gets the end date of the market data available for the underlying symbol.

string SymbolExchangeID()

Gets the exchange ID of the underlying symbol. (e.g. NYSE, NASDAQ, LSE, etc.)

string SymbolExchangeID(int, int)

Gets the exchange ID of a specified symbol. (e.g. NYSE, NASDAQ, LSE, etc.)

int[] SymbolFindIndex(string)

Gets the symbol indexes that match a specified symbol ID.

long[] SymbolHolidayDates()

Gets the list of holiday dates for the underlying symbol. (The dates align with the holiday names returned by SymbolHolidayNames)

long[] SymbolHolidayDates(int, int)

Gets the list of holiday dates for a specified symbol. (The dates align with the holiday names returned by SymbolHolidayNames)

string[] SymbolHolidayNames()

Gets the list of holiday names for the underlying symbol. (The names align with the holiday dates returned by SymbolHolidayDates)

string[] SymbolHolidayNames(int, int)

Gets the list of holiday names for a specified symbol. (The names align with the holiday dates returned by SymbolHolidayDates)

string SymbolID()

Gets the symbol ID of the underlying symbol. (The ticker such as IBM, GOOG, EURUSD, etc.)

string SymbolID(int, int)

Gets the symbol ID of a specified symbol. (The ticker such as IBM, GOOG, EURUSD, etc.)

int SymbolIndex()

Gets the underlying symbol index.

string SymbolIndustry()

Gets the industry of the underlying symbol.

string SymbolIndustry(int, int)

Gets the industry of a specified symbol.

C_Instrument SymbolInstrument()

Gets the instrument of the underlying symbol.

C_Instrument SymbolInstrument(int, int)

Gets the instrument of a specified symbol.

bool SymbolIsActive()

Determines whether the underlying symbol is actively traded in the exchange (has not been delisted).

bool SymbolIsActive(int, int)

Determines whether a specified symbol is actively traded in the exchange (has not been delisted).

bool SymbolIsAvailable()

Determines whether the underlying symbol is available in the strategy symbol table.

bool SymbolIsAvailable(int, int)

Determines whether a specified symbol is available in the strategy symbol table.

bool SymbolIsCashSettled()

Determines whether the underlying symbol is that of a cash-settled futures contract.

bool SymbolIsCashSettled(int, int)

Determines whether a specified symbol is that of a cash-settled futures contract.

bool SymbolIsContinuousBackAdjusted()

Determines whether the underlying symbol is that of a continuous back-adjusted futures contract.

bool SymbolIsContinuousBackAdjusted(int, int)

Determines whether a specified symbol is that of a continuous back-adjusted futures contract.

bool SymbolIsContinuousByDataProvider()

Determines whether the underlying symbol is that of a continuous futures contract by the data provider.

bool SymbolIsContinuousByDataProvider(int, int)

Determines whether a specified symbol is that of a continuous futures contract by the data provider.

bool SymbolIsContinuousNonBackAdjusted()

Determines whether the underlying symbol is that of a continuous non-back-adjusted futures contract.

bool SymbolIsContinuousNonBackAdjusted(int, int)

Determines whether a specified symbol is that of a continuous non-back-adjusted futures contract.

bool SymbolIsFrontMonthContract()

Determines whether the underlying symbol is the front month futures contract.

bool SymbolIsFrontMonthContract(int, int)

Determines whether a specified symbol is the front month futures contract.

bool SymbolIsSingleContract()

Determines whether the underlying symbol is that of a single futures contract.

bool SymbolIsSingleContract(int, int)

Determines whether a specified symbol is that of a single futures contract.

double SymbolMargin()

Gets the margin percent of the underlying forex or futures symbol.

double SymbolMargin(int, int)

Gets the margin percent of a specified forex or futures symbol.

string SymbolName()

Gets the full name of the underlying symbol.

string SymbolName(int, int)

Gets the full name of a specified symbol.

double SymbolPointValue()

Gets the point value of the underlying symbol.

double SymbolPointValue(int, int)

Gets the point value of a specified symbol.

long SymbolRolloverDate()

Gets the rollover date of the underlying futures symbol, i.e. the date in which most traders rollover into the next contract.

long SymbolRolloverDate(int, int)

Gets the rollover date of a specified futures symbol, i.e. the date in which most traders rollover into the next contract.

long SymbolRolloverDates()

Gets the rollover dates of the underlying futures symbol, i.e. the dates in which most traders rollover into the next contract (starting from the current Desktop time and going forward).

long SymbolRolloverDates(int, int)

Gets the rollover dates of a specified futures symbol, i.e. the dates in which most traders rollover into the next contract (starting from the current Desktop time and going forward).

string SymbolSector()

Gets the sector of the underlying symbol.

string SymbolSector(int, int)

Gets the sector of a specified symbol.

long SymbolStartDate()

Gets the start date of the market data available for the underlying symbol.

SymbolSwitch(int)

Switches the underlying symbol to a specified symbol for all API functions, including Data, Broker, Session and Symbol functions, among others.

double SymbolTickSize()

Gets the tick/pip size of the underlying symbol, i.e. the minimum amount that the price of a symbol can fluctuate upward or downward.

double SymbolTickSize(int, int)

Gets the tick/pip of a specified symbol, i.e. the minimum amount that the price of a symbol can fluctuate upward or downward.

double SymbolTicksPerPoint()

Gets the number of ticks per point of the underlying symbol.

double SymbolTicksPerPoint(int, int)

Gets the number of ticks per point of a specified symbol.

double SymbolTickValue()

Gets the tick value of the underlying futures symbol.

double SymbolTickValue(int, int)

Gets the tick value of a specified futures symbol.

C_TimeZone SymbolTimeZone()

Gets the time zone of the underlying symbol.

C_TimeZone SymbolTimeZone(int, int)

Gets the time zone of a specified symbol.


Function Details


string SymbolBaseCurrencyCode()

Gets the base currency code of the underlying forex symbol, i.e. the first currency in the pair.


Returns


The base currency code of the forex symbol, i.e. the first currency in the pair.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


string SymbolBaseCurrencyCode(int strategyNumber, int symbolIndex)

Gets the base currency code of a specified forex symbol, i.e. the first currency in the pair.


Returns


The base currency code of the specified forex symbol, i.e. the first currency in the pair.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


int SymbolContractMonth()

Gets the contract month of the underlying futures symbol.


Returns


The contract month of the underlying futures symbol (1 to 12).


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


int SymbolContractMonth(int strategyNumber, int symbolIndex)

Gets the contract month of a specified futures symbol.


Returns


The contract month of the specified futures symbol (1 to 12).


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


int SymbolContractYear()

Gets the contract year of the underlying futures symbol.


Returns


The contract year of the underlying futures symbol (YYYY).


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


int SymbolContractYear(int strategyNumber, int symbolIndex)

Gets the contract year of a specified futures symbol.


Returns


The contract year of the specified futures symbol (YYYY).


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


int SymbolCount()

Gets the number of symbols in the symbols table.


Returns


The number of symbols in the symbols table.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


int SymbolCount(int strategyNumber)

Gets the number of symbols in the symbols table of a specified strategy.


Returns


The number of symbols in the symbols table of the specified strategy.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


string SymbolCurrencyCode()

Gets the currency code of the underlying symbol (the second currency code in a forex pair).


Returns


The currency code of the underlying symbol (the second currency code in a forex pair).


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


string SymbolCurrencyCode(int strategyNumber, int symbolIndex)

Gets the currency code of a specified symbol (the second currency code in a forex pair).


Returns


The currency code of the specified symbol (the second currency code in a forex pair).


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


int SymbolDecimals()

Gets the number of decimals in the tick/pip of the underlying symbol.


Returns


The number of decimals in the tick/pip of the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


int SymbolDecimals(int strategyNumber, int symbolIndex)

Gets the number of decimals in the tick/pip of a specified symbol.


Returns


The number of decimals in the tick/pip of the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


long SymbolEndDate()

Gets the end date of the market data available for the underlying symbol.


Returns


The end date of the market data available for the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


string SymbolExchangeID()

Gets the exchange ID of the underlying symbol. (e.g. NYSE, NASDAQ, LSE, etc.)


Returns


The exchange ID of the underlying symbol. (e.g. NYSE, NASDAQ, LSE, etc.)


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


string SymbolExchangeID(int strategyNumber, int symbolIndex)

Gets the exchange ID of a specified symbol. (e.g. NYSE, NASDAQ, LSE, etc.)


Returns


The exchange ID of the specified symbol. (e.g. NYSE, NASDAQ, LSE, etc.)


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


int[] SymbolFindIndex(string symbolID)

Gets the symbol indexes that match a specified symbol ID.


Returns


The symbol indexes that match the specified symbol ID.


Parameters


Type

Identifier

Description

string

symbolID

The symbol ID of the specified symbol. (The ticker such as IBM, GOOG, EURUSD, etc.)


Scripts


MultiSymbolTradingStrategy


long[] SymbolHolidayDates()

Gets the list of holiday dates for the underlying symbol. (The dates align with the holiday names returned by SymbolHolidayNames)


Returns


The list of holiday dates for the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


long[] SymbolHolidayDates(int strategyNumber, int symbolIndex)

Gets the list of holiday dates for a specified symbol. (The dates align with the holiday names returned by SymbolHolidayNames)


Returns


The list of holiday dates for the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


string[] SymbolHolidayNames()

Gets the list of holiday names for the underlying symbol. (The names align with the holiday dates returned by SymbolHolidayDates)


Returns


The list of all holiday names for the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


string[] SymbolHolidayNames(int strategyNumber, int symbolIndex)

Gets the list of holiday names for a specified symbol. (The names align with the holiday dates returned by SymbolHolidayDates)


Returns


The list of all holiday names for the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


string SymbolID()

Gets the symbol ID of the underlying symbol. (The ticker such as IBM, GOOG, EURUSD, etc.)


Returns


The symbol ID of the underlying symbol. (The ticker such as IBM, GOOG, EURUSD, etc.)


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


string SymbolID(int strategyNumber, int symbolIndex)

Gets the symbol ID of a specified symbol. (The ticker such as IBM, GOOG, EURUSD, etc.)


Returns


The symbol ID of the specified symbol. (The ticker such as IBM, GOOG, EURUSD, etc.)


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


int SymbolIndex()

Gets the underlying symbol index.


Returns


The underlying symbol index.


Scripts


Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, Signal, TradingStrategy, PositionSizing


string SymbolIndustry()

Gets the industry of the underlying symbol.


Returns


The industry of the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


string SymbolIndustry(int strategyNumber, int symbolIndex)

Gets the industry of a specified symbol.


Returns


The industry of the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


C_Instrument SymbolInstrument()

Gets the instrument of the underlying symbol.


Returns


The instrument of the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


C_Instrument SymbolInstrument(int strategyNumber, int symbolIndex)

Gets the instrument of a specified symbol.


Returns


The instrument of the underlying symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


bool SymbolIsActive()

Determines whether the underlying symbol is actively traded in the exchange (has not been delisted).


Returns


True if the underlying symbol is actively traded in the exchange, false if it is not.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


bool SymbolIsActive(int strategyNumber, int symbolIndex)

Determines whether a specified symbol is actively traded in the exchange (has not been delisted).


Returns


True if the specified symbol is actively traded in the exchange, false if it is not.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


bool SymbolIsAvailable()

Determines whether the underlying symbol is available in the strategy symbol table.


Returns


True if the underlying symbol is available, false if it is not.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


bool SymbolIsAvailable(int strategyNumber, int symbolIndex)

Determines whether a specified symbol is available in the strategy symbol table.


Returns


True if the specified symbol is available, false if it is not.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


bool SymbolIsCashSettled()

Determines whether the underlying symbol is that of a cash-settled futures contract.


Returns


True if the underlying symbol is that of a cash-settled futures contract, false otherwise.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


bool SymbolIsCashSettled(int strategyNumber, int symbolIndex)

Determines whether a specified symbol is that of a cash-settled futures contract.


Returns


True if the specified symbol is that of a cash-settled futures contract, false otherwise.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


bool SymbolIsContinuousBackAdjusted()

Determines whether the underlying symbol is that of a continuous back-adjusted futures contract.


Returns


True if the underlying symbol is that of a continuous back-adjusted futures contract, false otherwise.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


bool SymbolIsContinuousBackAdjusted(int strategyNumber, int symbolIndex)

Determines whether a specified symbol is that of a continuous back-adjusted futures contract.


Returns


True if the specified symbol is that of a continuous back-adjusted futures contract, false otherwise.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


bool SymbolIsContinuousByDataProvider()

Determines whether the underlying symbol is that of a continuous futures contract by the data provider.


Returns


True if the underlying symbol is that of a continuous futures contract by the data provider, false otherwise.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


bool SymbolIsContinuousByDataProvider(int strategyNumber, int symbolIndex)

Determines whether a specified symbol is that of a continuous futures contract by the data provider.


Returns


True if the specified symbol is that of a continuous futures contract by the data provider, false otherwise.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


bool SymbolIsContinuousNonBackAdjusted()

Determines whether the underlying symbol is that of a continuous non-back-adjusted futures contract.


Returns


True if the underlying symbol is that of a continuous non-back-adjusted futures contract, false otherwise.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


bool SymbolIsContinuousNonBackAdjusted(int strategyNumber, int symbolIndex)

Determines whether a specified symbol is that of a continuous non-back-adjusted futures contract.


Returns


True if the specified symbol is that of a continuous non-back-adjusted futures contract, false otherwise.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


bool SymbolIsFrontMonthContract()

Determines whether the underlying symbol is the front month futures contract.


Returns


True if the underlying symbol is the front month futures contract, false otherwise.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


bool SymbolIsFrontMonthContract(int strategyNumber, int symbolIndex)

Determines whether a specified symbol is the front month futures contract.


Returns


True if the specified symbol is the front month futures contract, false otherwise.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


bool SymbolIsSingleContract()

Determines whether the underlying symbol is that of a single futures contract.


Returns


True if the underlying symbol is that of a single futures contract, false otherwise.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


bool SymbolIsSingleContract(int strategyNumber, int symbolIndex)

Determines whether a specified symbol is that of a single futures contract.


Returns


True if the specified symbol is that of a single futures contract, false otherwise.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


double SymbolMargin()

Gets the margin percent of the underlying forex or futures symbol. 


Futures: PointValue * (EntryPrice * Qty) * (Margin / 100)

Forex: (EntryPrice * Qty) * (Margin / 100)


Returns


The margin of the underlying forex or futures symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


double SymbolMargin(int strategyNumber, int symbolIndex)

Gets the margin percent of a specified forex or futures symbol.


Futures: PointValue * (EntryPrice * Qty) * (Margin / 100)

Forex: (EntryPrice * Qty) * (Margin / 100)


Returns


The margin of the specified forex or futures symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


string SymbolName()

Gets the full name of the underlying symbol.


Returns


The full name of the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


string SymbolName(int strategyNumber, int symbolIndex)

Gets the full name of a specified symbol.


Returns


The full name of the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


double SymbolPointValue()

Gets the point value of the underlying symbol.


Returns


The point value of the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


double SymbolPointValue(int strategyNumber, int symbolIndex)

Gets the point value of a specified symbol.


Returns


The point value of the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


long SymbolRolloverDate()

Gets the rollover date of the underlying futures symbol, i.e. the date in which most traders rollover into the next contract.


Returns


The rollover date of the underlying futures symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


long SymbolRolloverDate(int strategyNumber, int symbolIndex)

Gets the rollover date of a specified futures symbol, i.e. the date in which most traders rollover into the next contract.


Returns


The rollover date of a specified futures symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


long SymbolRolloverDates()

Gets the rollover dates of the underlying futures symbol, i.e. the dates in which most traders rollover into the next contract (starting from the current Desktop time and going forward).


Returns


The rollover dates of the underlying futures symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


long SymbolRolloverDates(int strategyNumber, int symbolIndex)

Gets the rollover dates of a specified futures symbol, i.e. the dates in which most traders rollover into the next contract (starting from the current Desktop time and going forward).


Returns


The rollover dates of the specified futures symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


string SymbolSector()

Gets the sector of the underlying symbol.


Returns


The sector of the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


string SymbolSector(int strategyNumber, int symbolIndex)

Gets the sector of a specified symbol.


Returns


The sector of the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


long SymbolStartDate()

Gets the start date of the market data available for the underlying symbol.


Returns


The start date of the market data available for the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


SymbolSwitch(int symbolIndex)

Switches the underlying symbol to a specified symbol for all API functions, including Data, Broker, Session and Symbol functions, among others.


Parameters


Type

Identifier

Description

int

symbolIndex

The symbol index in the symbols table


Scripts


Alert, MultiSymbolTradingStrategy


double SymbolTickSize()

Gets the tick/pip size of the underlying symbol, i.e. the minimum amount that the price of a symbol can fluctuate upward or downward.


Returns


The tick/pip of the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


double SymbolTickSize(int strategyNumber, int symbolIndex)

Gets the tick/pip of a specified symbol, i.e. the minimum amount that the price of a symbol can fluctuate upward or downward.


Returns


The tick/pip of the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


double SymbolTicksPerPoint()

Gets the number of ticks per point of the underlying symbol.


Returns


The number of ticks per point of the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


double SymbolTicksPerPoint(int strategyNumber, int symbolIndex)

Gets the number of ticks per point of a specified symbol.


Returns


The number of ticks per point of the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


double SymbolTickValue()

Gets the tick value of the underlying futures symbol.


Returns


The tick value of the underlying futures symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


double SymbolTickValue(int strategyNumber, int symbolIndex)

Gets the tick value of a specified futures symbol.


Returns


The tick value of the specified futures symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem


C_TimeZone SymbolTimeZone()

Gets the time zone of the underlying symbol.


Returns


The time zone of the underlying symbol.


Scripts


Alert, TradeManagementStrategy, Drawing, Indicator, MultiSymbolTradingStrategy, Screener, Pattern, PositionSizing, Signal, TradingStrategy


C_TimeZone SymbolTimeZone(int strategyNumber, int symbolIndex)

Gets the time zone of a specified symbol.


Returns


The time zone of the specified symbol.


Parameters


Type

Identifier

Description

int

strategyNumber

The strategy number

int

symbolIndex

The symbol index in the symbols table


Scripts


AddOn, Commission, DynamicAllocation, PerformanceMetric, RiskManagement, Slippage, TaxSystem