IFinancialInstrument (JForex API 2.12.46 API)

```
public interface IFinancialInstrument
```
The IFinancialInstrument instrument holds information about a particular financial instrument.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IFinancialInstrument.Type

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IFinancialInstrument.Type`

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`getAmountPerContract()`
`IBreakTime[]`	`getBreakTimes()`
`IInstrumentCommission[]`	`getCommissions()`
`String`	`getCountry()`
`int`	`getDefaultMarketSlippage()`
`int`	`getDefaultStopLossSlippage()`
`String`	`getDescription()` Returns the description of the instrument
`long`	`getExpirationTime()`
`IInstrumentGroup`	`getGroup()` Returns the instrument's group
`ICurrency`	`getMarginCurrency()`
`double`	`getMarginUse()`
`double`	`getMarginUseWeekend()`
`int`	`getMarketCloseDay()`
`long`	`getMarketCloseTime()`
`String`	`getMarketName()`
`int`	`getMarketOpenDay()`
`long`	`getMarketOpenTime()`
`String`	`getMarketShortName()`
`double`	`getMinTradeAmount()`
`String`	`getName()` Returns the name of the instrument
`int`	`getPipScale()` Returns decimal place count of one pip of the instrument
`double`	`getPipValue()` Returns value of one pip of the instrument
`ICurrency`	`getPrimaryCurrency()` Returns primary currency of the instrument
`ICurrency`	`getSecondaryCurrency()` Returns secondary currency of the instrument
`int`	`getTickScale()` Returns decimal place count of instrument's tick size
`double`	`getTickSize()` Returns value of minimum price movement of a trading instrument
`JFTimeZone`	`getTimeZone()`
`double`	`getTradeAmountIncrement()`
`IFinancialInstrument.Type`	`getType()` Instrument's type
`boolean`	`isExotic()`

- Method Detail
  - getType
```
IFinancialInstrument.Type getType()
```
    Instrument's type
    
    Returns:
    instrument's type
  - getGroup
```
IInstrumentGroup getGroup()
```
    Returns the instrument's group
    
    Returns:
    the instrument's group
  - getDescription
```
String getDescription()
```
    Returns the description of the instrument
    
    Returns:
    the description of the instrument
  - getName
```
String getName()
```
    Returns the name of the instrument
    
    Returns:
    the name of the instrument
  - getPrimaryCurrency
```
ICurrency getPrimaryCurrency()
```
    Returns primary currency of the instrument
    
    Returns:
    primary currency of the instrument
  - getSecondaryCurrency
```
ICurrency getSecondaryCurrency()
```
    Returns secondary currency of the instrument
    
    Returns:
    secondary currency of the instrument
  - getPipValue
```
double getPipValue()
```
    Returns value of one pip of the instrument
    
    Returns:
    value of one pip of the instrument
  - getPipScale
```
int getPipScale()
```
    Returns decimal place count of one pip of the instrument
    
    Returns:
    decimal place count of one pip of the instrument
  - getTickSize
```
double getTickSize()
```
    Returns value of minimum price movement of a trading instrument
    
    Returns:
    value of minimum price movement of a trading instrument
  - getTickScale
```
int getTickScale()
```
    Returns decimal place count of instrument's tick size
    
    Returns:
    decimal place count of instrument's tick size
  - getMinTradeAmount
```
double getMinTradeAmount()
```
  - getTradeAmountIncrement
```
double getTradeAmountIncrement()
```
  - getAmountPerContract
```
double getAmountPerContract()
```
  - getMarketOpenDay
```
int getMarketOpenDay()
```
  - getMarketOpenTime
```
long getMarketOpenTime()
```
  - getMarketCloseDay
```
int getMarketCloseDay()
```
  - getMarketCloseTime
```
long getMarketCloseTime()
```
  - getBreakTimes
```
IBreakTime[] getBreakTimes()
```
  - getExpirationTime
```
long getExpirationTime()
```
  - getMarginCurrency
```
ICurrency getMarginCurrency()
```
  - getMarginUse
```
double getMarginUse()
```
  - getMarginUseWeekend
```
double getMarginUseWeekend()
```
  - getCommissions
```
IInstrumentCommission[] getCommissions()
```
  - getTimeZone
```
JFTimeZone getTimeZone()
```
  - getCountry
```
String getCountry()
```
  - getMarketName
```
String getMarketName()
```
  - getMarketShortName
```
String getMarketShortName()
```
  - getDefaultMarketSlippage
```
int getDefaultMarketSlippage()
```
  - getDefaultStopLossSlippage
```
int getDefaultStopLossSlippage()
```
  - isExotic
```
boolean isExotic()
```

Interface IFinancialInstrument

Nested Class Summary

Method Summary

Method Detail

getType

getGroup

getDescription

getName

getPrimaryCurrency

getSecondaryCurrency

getPipValue

getPipScale

getTickSize

getTickScale

getMinTradeAmount

getTradeAmountIncrement

getAmountPerContract

getMarketOpenDay

getMarketOpenTime

getMarketCloseDay

getMarketCloseTime

getBreakTimes

getExpirationTime

getMarginCurrency

getMarginUse

getMarginUseWeekend

getCommissions

getTimeZone

getCountry

getMarketName

getMarketShortName

getDefaultMarketSlippage

getDefaultStopLossSlippage

isExotic