Skip to main content

Interface: InstrumentInfo

Broker.InstrumentInfo

Properties​

allowedDurations​

• Optional allowedDurations: string[]

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

allowedOrderTypes​

• Optional allowedOrderTypes: OrderType[]

Supported order types for the instrument

baseCurrency​

• Optional baseCurrency: string

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

bigPointValue​

• Optional bigPointValue: number

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.

brokerSymbol​

• Optional brokerSymbol: string

Display name for the symbol

currency​

• Optional currency: string

Instrument currency that is displayed in Order Ticket

description​

• description: string

A description to be displayed in the UI dialogs.

domVolumePrecision​

• Optional domVolumePrecision: number

Number of decimal places of DOM asks/bids volume (optional, 0 by default).

leverage​

• Optional leverage: string

Leverage

limitPriceStep​

• Optional limitPriceStep: number

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

lotSize​

• Optional lotSize: number

Lot size

marginRate​

• Optional marginRate: number

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

minTick​

• minTick: number

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

pipSize​

• pipSize: number

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

pipValue​

• pipValue: number

Value of 1 pip for the instrument in the account currency

priceMagnifier​

• Optional priceMagnifier: number

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

qty​

• qty: QuantityMetainfo

Quantity field step and boundaries

quoteCurrency​

• Optional quoteCurrency: string

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

stopPriceStep​

• Optional stopPriceStep: number

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

type​

• Optional type: SymbolType

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

units​

• Optional units: string

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

variableMinTick​

• Optional variableMinTick: string

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.