MetatraderSymbolSpecification (cloud.metaapi.sdk:metaapi-java-sdk 10.1.0 API)

java.lang.Object
- cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification

```
public class MetatraderSymbolSpecification
extends Object
```
MetaTrader symbol specification. Contains symbol specification (see https://metaapi.cloud/docs/client/models/metatraderSymbolSpecification/)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MetatraderSymbolSpecification.CalcMode` Contract price calculation mode.
`static class`	`MetatraderSymbolSpecification.ExecutionMode` Deal execution mode.
`static class`	`MetatraderSymbolSpecification.ExpirationMode` Order expiration mode.
`static class`	`MetatraderSymbolSpecification.FillingMode` Order filling mode.
`static class`	`MetatraderSymbolSpecification.OrderGtcMode` Order GTC mode.
`static class`	`MetatraderSymbolSpecification.OrderType` Order type.
`static class`	`MetatraderSymbolSpecification.SwapMode` Swap calculation model.
`static class`	`MetatraderSymbolSpecification.TradeMode` Order execution type.

Field Summary

Fields
Modifier and Type	Field and Description
`List<MetatraderSymbolSpecification.ExpirationMode>`	`allowedExpirationModes` Allowed order expiration modes
`List<MetatraderSymbolSpecification.OrderType>`	`allowedOrderTypes` Allowed order types
`String`	`baseCurrency` Base currency
`Double`	`bondAccruedInterest` Accrued interest, or `null` – accumulated coupon interest, i.e. part of the coupon interest calculated in proportion to the number of days since the coupon bond issuance or the last coupon interest payment
`Double`	`bondFaceValue` Face value, or `null` – initial bond value set by the issuer
`int`	`contractSize` Trade contract size
`String`	`description` Symbol description
`int`	`digits` Digits after a decimal point
`MetatraderSymbolSpecification.ExecutionMode`	`executionMode` Deal execution mode
`IsoTime`	`expirationTime` Date of the symbol trade end (usually used for futures)
`List<MetatraderSymbolSpecification.FillingMode>`	`fillingModes` List of allowed order filling modes
`double`	`hedgedMargin` Contract size or margin value per one lot of hedged positions (oppositely directed positions of one symbol).
`Boolean`	`hedgedMarginUsesLargerLeg` Calculating hedging margin using the larger leg (Buy or Sell), or `null`
`double`	`initialMargin` Initial margin means the amount in the margin currency required for opening a position with the volume of one lot.
`Double`	`liquidityRate` Liquidity Rate is the share of the asset that can be used for the margin, or `null`
`double`	`maintenanceMargin` The maintenance margin.
`String`	`marginCurrency` Margin currency
`double`	`maxVolume` Maximum order volume for the symbol
`double`	`minVolume` Minimum order volume for the symbol
`Double`	`optionPriceSensivity` Option/warrant sensitivity shows by how many points the price of the option's underlying asset should change so that the price of the option changes by one point, or `null`
`Double`	`optionStrike` The strike price of an option, or `null`.
`MetatraderSymbolSpecification.OrderGtcMode`	`orderGTCMode` If the expirationMode property is set to SYMBOL_EXPIRATION_GTC (good till canceled), the expiration of pending orders, as well as of Stop Loss/Take Profit orders should be additionally set using this enumeration
`String`	`path` Path in the symbol tree, or `null`
`MetatraderSymbolSpecification.CalcMode`	`priceCalculationMode` Contract price calculation mode
`String`	`profitCurrency` Profit currency, or `null`
`MetatraderSessions`	`quoteSessions` Quote sessions, indexed by day of week
`IsoTime`	`startTime` Date of the symbol trade beginning (usually used for futures)
`Double`	`swapLong` Long swap value, or `null`
`MetatraderSymbolSpecification.SwapMode`	`swapMode` Swap calculation model
`DayOfWeek`	`swapRollover3Days` Day of week to charge 3 days swap rollover, or `null`
`Double`	`swapShort` Short swap value, or `null`
`String`	`symbol` Symbol (e.g. a currency pair or an index)
`double`	`tickSize` Tick size
`MetatraderSymbolSpecification.TradeMode`	`tradeMode` Order execution type, or `null`
`MetatraderSessions`	`tradeSessions` Trade sessions, indexed by day of week
`double`	`volumeStep` Order volume step for the symbol

Constructor Summary

Constructors
Constructor and Description

MetatraderSymbolSpecification()

Constructors
Constructor and Description
`MetatraderSymbolSpecification()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - symbol
```
public String symbol
```
    Symbol (e.g. a currency pair or an index)
  - tickSize
```
public double tickSize
```
    Tick size
  - minVolume
```
public double minVolume
```
    Minimum order volume for the symbol
  - maxVolume
```
public double maxVolume
```
    Maximum order volume for the symbol
  - volumeStep
```
public double volumeStep
```
    Order volume step for the symbol
  - fillingModes
```
public List<MetatraderSymbolSpecification.FillingMode> fillingModes
```
    List of allowed order filling modes
  - executionMode
```
public MetatraderSymbolSpecification.ExecutionMode executionMode
```
    Deal execution mode
  - contractSize
```
public int contractSize
```
    Trade contract size
  - quoteSessions
```
public MetatraderSessions quoteSessions
```
    Quote sessions, indexed by day of week
  - tradeSessions
```
public MetatraderSessions tradeSessions
```
    Trade sessions, indexed by day of week
  - tradeMode
```
public MetatraderSymbolSpecification.TradeMode tradeMode
```
    Order execution type, or null
  - bondAccruedInterest
```
public Double bondAccruedInterest
```
    Accrued interest, or null – accumulated coupon interest, i.e. part of the coupon interest calculated in proportion to the number of days since the coupon bond issuance or the last coupon interest payment
  - bondFaceValue
```
public Double bondFaceValue
```
    Face value, or null – initial bond value set by the issuer
  - optionStrike
```
public Double optionStrike
```
    The strike price of an option, or null. The price at which an option buyer can buy (in a Call option) or sell (in a Put option) the underlying asset, and the option seller is obliged to sell or buy the appropriate amount of the underlying asset
  - optionPriceSensivity
```
public Double optionPriceSensivity
```
    Option/warrant sensitivity shows by how many points the price of the option's underlying asset should change so that the price of the option changes by one point, or null
  - liquidityRate
```
public Double liquidityRate
```
    Liquidity Rate is the share of the asset that can be used for the margin, or null
  - initialMargin
```
public double initialMargin
```
    Initial margin means the amount in the margin currency required for opening a position with the volume of one lot. It is used for checking a client's assets when he or she enters the market
  - maintenanceMargin
```
public double maintenanceMargin
```
    The maintenance margin. If it is set, it sets the margin amount in the margin currency of the symbol, charged from one lot. It is used for checking a client's assets when his/her account state changes. If the maintenance margin is equal to 0, the initial margin is used
  - hedgedMargin
```
public double hedgedMargin
```
    Contract size or margin value per one lot of hedged positions (oppositely directed positions of one symbol). Two margin calculation methods are possible for hedged positions. The calculation method is defined by the broker
  - hedgedMarginUsesLargerLeg
```
public Boolean hedgedMarginUsesLargerLeg
```
    Calculating hedging margin using the larger leg (Buy or Sell), or null
  - marginCurrency
```
public String marginCurrency
```
    Margin currency
  - priceCalculationMode
```
public MetatraderSymbolSpecification.CalcMode priceCalculationMode
```
    Contract price calculation mode
  - baseCurrency
```
public String baseCurrency
```
    Base currency
  - profitCurrency
```
public String profitCurrency
```
    Profit currency, or null
  - swapMode
```
public MetatraderSymbolSpecification.SwapMode swapMode
```
    Swap calculation model
  - swapLong
```
public Double swapLong
```
    Long swap value, or null
  - swapShort
```
public Double swapShort
```
    Short swap value, or null
  - swapRollover3Days
```
public DayOfWeek swapRollover3Days
```
    Day of week to charge 3 days swap rollover, or null
  - allowedExpirationModes
```
public List<MetatraderSymbolSpecification.ExpirationMode> allowedExpirationModes
```
    Allowed order expiration modes
  - allowedOrderTypes
```
public List<MetatraderSymbolSpecification.OrderType> allowedOrderTypes
```
    Allowed order types
  - orderGTCMode
```
public MetatraderSymbolSpecification.OrderGtcMode orderGTCMode
```
    If the expirationMode property is set to SYMBOL_EXPIRATION_GTC (good till canceled), the expiration of pending orders, as well as of Stop Loss/Take Profit orders should be additionally set using this enumeration
  - digits
```
public int digits
```
    Digits after a decimal point
  - path
```
public String path
```
    Path in the symbol tree, or null
  - description
```
public String description
```
    Symbol description
  - startTime
```
public IsoTime startTime
```
    Date of the symbol trade beginning (usually used for futures)
  - expirationTime
```
public IsoTime expirationTime
```
    Date of the symbol trade end (usually used for futures)
- Constructor Detail
  - MetatraderSymbolSpecification
```
public MetatraderSymbolSpecification()
```

Class MetatraderSymbolSpecification

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

symbol

tickSize

minVolume

maxVolume

volumeStep

fillingModes

executionMode

contractSize

quoteSessions

tradeSessions

tradeMode

bondAccruedInterest

bondFaceValue

optionStrike

optionPriceSensivity

liquidityRate

initialMargin

maintenanceMargin

hedgedMargin

hedgedMarginUsesLargerLeg

marginCurrency

priceCalculationMode

baseCurrency

profitCurrency

swapMode

swapLong

swapShort

swapRollover3Days

allowedExpirationModes

allowedOrderTypes

orderGTCMode

digits

path

description

startTime

expirationTime

Constructor Detail

MetatraderSymbolSpecification