Skip to main content
Version: latest

InstrumentInfo

Interface
Types Module: Broker

Properties​

allowedDurations​

Optional

Array of strings with valid duration values. You can check that in Order Ticket.

Type​

​string[]

allowedOrderTypes​

Optional

Supported order types for the instrument

Type​

​OrderType[]

baseCurrency​

Optional

The first currency quoted in a currency pair. Used for crypto currencies only.

Type​

​string

bigPointValue​

Optional

The value represented by a full point of price movement in the contract currency. This value is used to calculate the Total Value (symbol currency) of the order.

Type​

​number

brokerSymbol​

Optional

Display name for the symbol

Type​

​string

currency​

Optional

Instrument currency that is displayed in Order Ticket

Type​

​string

description​

A description to be displayed in the UI dialogs.

Type​

​string

leverage​

Optional

Leverage

Type​

​string

limitPriceStep​

Optional

Minimal price change for limit price field of the Limit and Stop Limit order. If set it will override the minTick value.

Type​

​number

lotSize​

Optional

Lot size

Type​

​number

marginRate​

Optional

The margin requirement for the instrument. A 3% margin rate should be represented as 0.03.

Type​

​number

minTick​

Minimal price change (e.g., 0.00001 for EURUSD). Used for price fields.

Type​

​number

pipSize​

Size of 1 pip (e.g., 0.0001 for EURUSD)

Type​

​number

pipValue​

Value of 1 pip for the instrument in the account currency

Type​

​number

priceMagnifier​

Optional

The value represents how much price is multiplied in relation to base monetary unit.

Type​

​number

qty​

Quantity field step and boundaries

Type​

​QuantityMetainfo

quoteCurrency​

Optional

The second currency quoted in a currency pair. Used for crypto currencies only.

Type​

​string

stopPriceStep​

Optional

Minimal price change for stop price field of the Stop and Stop Limit order. If set it will override the minTick value.

Type​

​number

type​

Optional

Instrument type. forex enables negative pips. You can check that in Order Ticket.

Type​

​SymbolType

units​

Optional

Units of quantity or amount. Displayed instead of the Units label in the Quantity/Amount field.

Type​

​string

variableMinTick​

Optional

Dynamic minimum price movement. It is used if the instrument's minimum price movement changes depending on the price range.

For example: 0.01 10 0.02 25 0.05, where minTick is 0.01 for a price less than 10, minTick is 0.02 for a price less than 25, minTick is 0.05 for a price more and equal than 25.

Type​

​string