com.dukascopy.api
Interface IFXSentimentIndex

All Superinterfaces:
IFXTimedSentimentIndex

public interface IFXSentimentIndex
extends IFXTimedSentimentIndex

Forex Sentiment Index.
Shows the percentage of longs in the overall amount of open trades in the most popular currencies and currency pairs consolidated by liquidity consumers.
The sentiment ratio of Liquidity providers is opposite to Liquidity consumers (opposite to getIndexValue().
The index reflects the distribution of the current market conditions and is updated every 30 minutes.

See Also:
SWFX Sentiment Index

Method Summary
 double getIndexTendency()
          Returns the current index trend (percentage of LONG positions minus percentage of SHORT positions in overall amount of trades)
 long getIndexTime()
          Returns a settlement time of current index.
 double getIndexValue()
          Index's value ranges from 0 to 100 percents.
 

Method Detail

getIndexTime

long getIndexTime()
Returns a settlement time of current index. Sentiment index is updated by server every 30 minutes.

Specified by:
getIndexTime in interface IFXTimedSentimentIndex
Returns:
Returns a settlement time of current index.

getIndexValue

double getIndexValue()
Index's value ranges from 0 to 100 percents. In other words, the index value is percentage of LONG positions in the overall amount of open trades.
To calculate the percentage of SHORT positions in overall amount of trades use (100 - getIndexValue())

Returns:
the percentage of LONG positions in the overall amount of open trades.

getIndexTendency

double getIndexTendency()
Returns the current index trend (percentage of LONG positions minus percentage of SHORT positions in overall amount of trades)

Returns:
Returns the current index trend