class Instrument
Parents
object
Brief
The class provides access to instrument information
| Static Public Properties | |
|---|---|
| TYPE_FOREX | Type: FOREX |
| TYPE_INDICES | Type: INDICES |
| TYPE_COMMODITY | Type: COMMODITY |
| TYPE_TREASURY | Type: TREASURY |
| TYPE_BULLION | Type: BULLION |
| TYPE_SHARES | Type: SHARES |
| TYPE_FXINDEX | Type: FXINDEX |
| TYPE_CFD_SHARES | Type: CFD SHARES |
| TYPE_CRYPTOCURRENCY | Type: CRYPTOCURRENCY |
| Public Methods | |
|---|---|
| Instrument | This method is a constructor for the class providing access to instrument information. The constructor does not return any values |
| getOfferId | Gets the unique identification number of the instrument offer |
| getSymbol | Gets the symbol of the instrument. For example, EUR/USD |
| 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 |
| getDigits | Gets the instrument price precision |
| getPointSize | Gets the size of one pip |
| getInstrumentType | Gets the type of the instrument |
| getTradingStatus | Gets the instrument trading status |
| getContractMultiplier | Gets the contract multiplier (makes sense only for some CFD instruments) |
| getSellInterest | Gets the interest amount added to the account balance for holding a one lot short (sell) position overnight |
| getBuyInterest | Gets the interest amount added to the account balance for holding a one lot long (buy) position overnight |
| getSubscriptionStatus | Gets the instrument subscription status |
| hasDividendBuy | Answers the question of whether dividends have arrived for the instrument when buying |
| getDividendBuy | Gets the number of dividends when buying for this instrument |
| hasDividendSell | Answers the question of whether dividends have arrived for the instrument when selling |
| getDividendSell | Gets the number of dividends when selling for this instrument |
| getBaseUnitSize | Returns the base unit size of the instrument. This value represents the minimum trade size for this instrument |
| getMinQuantity | Gets the minimum allowed amount of an order |
| getMaxQuantity | Gets the maximum allowed amount of an order |
| getSortOrder | Gets the default sort order position |
| getPriceStreamId | Gets the ID of price stream |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |