class Instrument

Parents

object

Brief

The class provides access to instrument information

Static Public Properties

TYPE_BULLION

Type: BULLION

TYPE_CFD_SHARES

Type: CFD SHARES

TYPE_COMMODITY

Type: COMMODITY

TYPE_CRYPTOCURRENCY

Type: CRYPTOCURRENCY

TYPE_FOREX

Type: FOREX

TYPE_FXINDEX

Type: FXINDEX

TYPE_INDICES

Type: INDICES

TYPE_SHARES

Type: SHARES

TYPE_TREASURY

Type: TREASURY

Public Methods

getAskAdjustment

Returns the adjustment applied to the ask price of the instrument. The ask price is the price at which an investor can buy the instrument. The adjustment can be either positive or negative and is applied to account for factors such as market conditions, liquidity, and trading costs

getBaseUnitSize

Returns the base unit size of the instrument. This value represents the minimum trade size for this instrument

getBidAdjustment

Returns the adjustment applied to the bid price of the instrument. The bid price is the price at which an investor can sell the instrument. The adjustment can be either positive or negative and is applied to account for factors such as market conditions, liquidity, and trading costs

getBuyInterest

Gets the interest amount added to the account balance for holding a one lot long (buy) position overnight

getConditionDistEntryLimit

Returns the distance in points between the current market price and the limit order that has been placed when entering a trade. The limit order is an order to automatically close a trade when the price of the instrument reaches a certain level of profit

getConditionDistEntryStop

Returns the distance in points between the current market price and the stop-loss order that has been placed when entering a trade. The stop-loss order is an order to automatically close a trade if the price of the instrument moves against the trader by a specified amount

getConditionDistLimit

Returns the distance in points between the current market price and the limit order that has been placed for a trade. The limit order is an order to automatically close a trade when the price of the instrument reaches a certain level of profit

getConditionDistStop

Returns the distance in points between the current market price and the stop-loss order that has been placed for a trade. The stop-loss order is an order to automatically close a trade if the price of the instrument moves against the trader by a specified amount

getContractCurrency

Gets the contact currency depending on the instrument type: the base currency for a Forex instrument and the counter currency for a CFD instrument. For example, EUR for EUR/USD and GBP for UK100/GBP

getContractMultiplier

Gets the contract multiplier (makes sense only for some CFD instruments)

getDigits

Gets the instrument price precision

getDividendBuy

Gets the number of dividends when buying for this instrument

getDividendSell

Gets the number of dividends when selling for this instrument

getFractionalPipSize

Returns the size of a fractional pip for the instrument. The fractional pip size is the smallest fraction of a pip that the instrument can be traded in, and it is expressed in decimals

getInstrumentType

Gets the type of the instrument

getMaxQuantity

Gets the maximum allowed amount of an order

getMinQuantity

Gets the minimum allowed amount of an order

getOfferId

Gets the unique identification number of the instrument offer

getPointSize

Gets the size of one pip

getPriceStreamId

Gets the ID of price stream

getSellInterest

Gets the interest amount added to the account balance for holding a one lot short (sell) position overnight

getSortOrder

Gets the default sort order position

getSubscriptionStatus

Gets the instrument subscription status

getSymbol

Gets the symbol of the instrument. For example, EUR/USD

getTradingStatus

Gets the instrument trading status

hasDividendBuy

Answers the question of whether dividends have arrived for the instrument when buying

hasDividendSell

Answers the question of whether dividends have arrived for the instrument when selling

Instrument

This method is a constructor for the class providing access to instrument information. The constructor does not return any values

back