MetaStatsClient.Metrics (cloud.metaapi.sdk:metaapi-metastats-sdk 1.0.0 API)

java.lang.Object
- cloud.metaapi.sdk.clients.MetaStatsClient.Metrics

Enclosing class:: MetaStatsClient

public static class MetaStatsClient.Metrics
extends Object

Trading statistics metrics

Field Summary

Fields
Modifier and Type	Field and Description
`Double`	`absoluteGain` Simple deposit increase without regard to reinvestment, or `null`
`Double`	`averageHoldingPeriodReturn` Average holding period return, or `null`
`Double`	`averageLoss` Average loss in basic currency, or `null`
`Double`	`averageLossPips` Average loss in pips, or `null`
`Double`	`averageTradeLengthInMilliseconds` Average trade length (time from open to close) in milliseconds, or `null`
`Double`	`averageWin` Average win in basic currency, or `null`
`Double`	`averageWinPips` Average win in pips, or `null`
`double`	`balance` Money on the account, not accounting for the results of currently open positions
`Double`	`bestTrade` The best profit from one trade that has ever been on the account, or `null`
`String`	`bestTradeDate` Date of the best profit from one trade that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or `null`
`Double`	`bestTradePips` The best pips from one trade that has ever been on the account, or `null`
`String`	`bestTradePipsDate` Date of the best pips from one trade that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or `null`
`List<MetaStatsClient.TradeByTimeMetrics>`	`closeTradesByWeekDay` Closing deals by days of the week, or `null`
`Double`	`commissions` Commissions charged by the broker for the entire period, or `null`
`List<MetaStatsClient.CurrencySummaryMetrics>`	`currencySummary` Currency trading summary, or `null`
`Double`	`dailyGain` Compound daily rate of return, or `null`
`List<MetaStatsClient.DailyGrowthMetrics>`	`dailyGrowth` Daily gain shows the change in account profitability on trading days, or `null`
`Integer`	`daysSinceTradingStarted` The number of days that have passed since the opening of the first trade, or `null`
`double`	`deposits` Cumulative deposit for the entire period
`double`	`equity` The result (current amount) of all positions, including opened
`Double`	`equityPercent` Percentage of current equity to balance, or `null`
`Double`	`expectancy` The average expected profitability of one trade in basic currency, or `null`
`Double`	`expectancyPips` The average expected profitability of one trade in pips, or `null`
`Double`	`gain` Time-weighted rate of return, or `null`
`Double`	`geometricHoldingPeriodReturn` Geometric holding period return, or `null`
`Double`	`highestBalance` Maximum balance that have ever been on the account, or `null`
`String`	`highestBalanceDate` Date of maximum balance that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or `null`
`Boolean`	`inclusive` Indicates whether open positions are included in the metrics, "false" means that there are no open positions Only for a request with includeOpenPositions=true.
`Double`	`interest` Cumulative interest and swap for the entire period, or `null`
`Double`	`kurtosisProfit` A statistical measure that is used to describe profit distribution, or `null`
`Integer`	`longTrades` The number of long trades, or `null`
`Integer`	`longWonTrades` The number of long winning trades, or `null`
`Double`	`longWonTradesPercent` Percentage of long winning trades, or `null`
`Double`	`lostTradesPercent` Percentage of losing trades, or `null`
`Double`	`lots` Total volume of trades, or `null`
`Double`	`maxDrawdown` Percentage of maximum drawdown of balance during the entire trading history, or `null`
`List<MetaStatsClient.MonthlyAnalyticsMetrics>`	`monthlyAnalytics` Monthly analysis of trading on this account, or `null`
`Double`	`monthlyGain` Compound monthly rate of return, or `null`
`List<MetaStatsClient.TradeByTimeMetrics>`	`openTradesByHour` Opening deals by hour of the day, or `null`
`MetaStatsClient.Periods`	`periods` Trading stats for a few periods compared to the results for the previous period, or `null`
`Double`	`pips` Cumulative price units, or `null`
`Double`	`probability` Probability that a profit will be followed by a profit and a loss by a loss, or `null`
`double`	`profit` The total yield of closed positions for the entire period (total result)
`Double`	`profitFactor` The amount yielded by winning trades divided by the amount of losses yielded by losing trades, or `null`
`List<MetaStatsClient.RiskOfRuinMetrics>`	`riskOfRuin` Risk of ruin of balance, or `null`
`Double`	`sharpeRatio` Average return earned in excess of the risk-free rate per unit of volatility, or `null`
`Integer`	`shortTrades` The number of short trades, or `null`
`Integer`	`shortWonTrades` The number of short winning trades, or `null`
`Double`	`shortWonTradesPercent` Percentage of short winning trades, or `null`
`Double`	`sortinoRatio` Differentiates harmful volatility from total overall volatility, or `null`
`Double`	`standardDeviationProfit` Statistical measure of volatility shows how much variation or dispersion, or `null`
`MetaStatsClient.TradeDurationMetrics`	`tradeDuration` Metrics for each duration of trades, or `null`
`List<MetaStatsClient.TradeDurationDiagramColumnMetrics>`	`tradeDurationDiagram` List of information columns about the duration of trades for the diagram, or `null`
`int`	`trades` Total number of closed positions on the account
`Double`	`withdrawals` Total amount withdrawn from the deposit, or `null`
`Double`	`wonTradesPercent` Percentage of winning trades, or `null`
`Double`	`worstTrade` The worst profit from one trade that has ever been on the account, or `null`
`String`	`worstTradeDate` Date of the worst profit from one trade that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or `null`
`Double`	`worstTradePips` The worst pips from one trade that has ever been on the account, or `null`
`String`	`worstTradePipsDate` Date of the worst pips from one trade that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or `null`
`Double`	`zScore` Ability of a trading system to generate wins and losses in streaks, or `null`

Constructor Summary

Constructors
Constructor and Description

Metrics()

Constructors
Constructor and Description
`Metrics()`

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

- Field Detail
  - inclusive
```
public Boolean inclusive
```
    Indicates whether open positions are included in the metrics, "false" means that there are no open positions Only for a request with includeOpenPositions=true. Can be null
  - balance
```
public double balance
```
    Money on the account, not accounting for the results of currently open positions
  - highestBalanceDate
```
public String highestBalanceDate
```
    Date of maximum balance that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or null
  - highestBalance
```
public Double highestBalance
```
    Maximum balance that have ever been on the account, or null
  - equity
```
public double equity
```
    The result (current amount) of all positions, including opened
  - trades
```
public int trades
```
    Total number of closed positions on the account
  - withdrawals
```
public Double withdrawals
```
    Total amount withdrawn from the deposit, or null
  - averageTradeLengthInMilliseconds
```
public Double averageTradeLengthInMilliseconds
```
    Average trade length (time from open to close) in milliseconds, or null
  - bestTrade
```
public Double bestTrade
```
    The best profit from one trade that has ever been on the account, or null
  - worstTrade
```
public Double worstTrade
```
    The worst profit from one trade that has ever been on the account, or null
  - bestTradePips
```
public Double bestTradePips
```
    The best pips from one trade that has ever been on the account, or null
  - worstTradePips
```
public Double worstTradePips
```
    The worst pips from one trade that has ever been on the account, or null
  - bestTradeDate
```
public String bestTradeDate
```
    Date of the best profit from one trade that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or null
  - bestTradePipsDate
```
public String bestTradePipsDate
```
    Date of the best pips from one trade that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or null
  - worstTradeDate
```
public String worstTradeDate
```
    Date of the worst profit from one trade that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or null
  - worstTradePipsDate
```
public String worstTradePipsDate
```
    Date of the worst pips from one trade that have ever been on the account, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or null
  - commissions
```
public Double commissions
```
    Commissions charged by the broker for the entire period, or null
  - dailyGain
```
public Double dailyGain
```
    Compound daily rate of return, or null
  - monthlyGain
```
public Double monthlyGain
```
    Compound monthly rate of return, or null
  - equityPercent
```
public Double equityPercent
```
    Percentage of current equity to balance, or null
  - expectancy
```
public Double expectancy
```
    The average expected profitability of one trade in basic currency, or null
  - expectancyPips
```
public Double expectancyPips
```
    The average expected profitability of one trade in pips, or null
  - gain
```
public Double gain
```
    Time-weighted rate of return, or null
  - geometricHoldingPeriodReturn
```
public Double geometricHoldingPeriodReturn
```
    Geometric holding period return, or null
  - interest
```
public Double interest
```
    Cumulative interest and swap for the entire period, or null
  - longTrades
```
public Integer longTrades
```
    The number of long trades, or null
  - shortTrades
```
public Integer shortTrades
```
    The number of short trades, or null
  - longWonTrades
```
public Integer longWonTrades
```
    The number of long winning trades, or null
  - shortWonTrades
```
public Integer shortWonTrades
```
    The number of short winning trades, or null
  - longWonTradesPercent
```
public Double longWonTradesPercent
```
    Percentage of long winning trades, or null
  - shortWonTradesPercent
```
public Double shortWonTradesPercent
```
    Percentage of short winning trades, or null
  - maxDrawdown
```
public Double maxDrawdown
```
    Percentage of maximum drawdown of balance during the entire trading history, or null
  - lots
```
public Double lots
```
    Total volume of trades, or null
  - pips
```
public Double pips
```
    Cumulative price units, or null
  - profit
```
public double profit
```
    The total yield of closed positions for the entire period (total result)
  - deposits
```
public double deposits
```
    Cumulative deposit for the entire period
  - absoluteGain
```
public Double absoluteGain
```
    Simple deposit increase without regard to reinvestment, or null
  - profitFactor
```
public Double profitFactor
```
    The amount yielded by winning trades divided by the amount of losses yielded by losing trades, or null
  - sharpeRatio
```
public Double sharpeRatio
```
    Average return earned in excess of the risk-free rate per unit of volatility, or null
  - sortinoRatio
```
public Double sortinoRatio
```
    Differentiates harmful volatility from total overall volatility, or null
  - standardDeviationProfit
```
public Double standardDeviationProfit
```
    Statistical measure of volatility shows how much variation or dispersion, or null
  - kurtosisProfit
```
public Double kurtosisProfit
```
    A statistical measure that is used to describe profit distribution, or null
  - averageHoldingPeriodReturn
```
public Double averageHoldingPeriodReturn
```
    Average holding period return, or null
  - averageWin
```
public Double averageWin
```
    Average win in basic currency, or null
  - averageWinPips
```
public Double averageWinPips
```
    Average win in pips, or null
  - averageLoss
```
public Double averageLoss
```
    Average loss in basic currency, or null
  - averageLossPips
```
public Double averageLossPips
```
    Average loss in pips, or null
  - wonTradesPercent
```
public Double wonTradesPercent
```
    Percentage of winning trades, or null
  - lostTradesPercent
```
public Double lostTradesPercent
```
    Percentage of losing trades, or null
  - zScore
```
public Double zScore
```
    Ability of a trading system to generate wins and losses in streaks, or null
  - probability
```
public Double probability
```
    Probability that a profit will be followed by a profit and a loss by a loss, or null
  - daysSinceTradingStarted
```
public Integer daysSinceTradingStarted
```
    The number of days that have passed since the opening of the first trade, or null
  - currencySummary
```
public List<MetaStatsClient.CurrencySummaryMetrics> currencySummary
```
    Currency trading summary, or null
  - dailyGrowth
```
public List<MetaStatsClient.DailyGrowthMetrics> dailyGrowth
```
    Daily gain shows the change in account profitability on trading days, or null
  - monthlyAnalytics
```
public List<MetaStatsClient.MonthlyAnalyticsMetrics> monthlyAnalytics
```
    Monthly analysis of trading on this account, or null
  - closeTradesByWeekDay
```
public List<MetaStatsClient.TradeByTimeMetrics> closeTradesByWeekDay
```
    Closing deals by days of the week, or null
  - openTradesByHour
```
public List<MetaStatsClient.TradeByTimeMetrics> openTradesByHour
```
    Opening deals by hour of the day, or null
  - periods
```
public MetaStatsClient.Periods periods
```
    Trading stats for a few periods compared to the results for the previous period, or null
  - riskOfRuin
```
public List<MetaStatsClient.RiskOfRuinMetrics> riskOfRuin
```
    Risk of ruin of balance, or null
  - tradeDuration
```
public MetaStatsClient.TradeDurationMetrics tradeDuration
```
    Metrics for each duration of trades, or null
  - tradeDurationDiagram
```
public List<MetaStatsClient.TradeDurationDiagramColumnMetrics> tradeDurationDiagram
```
    List of information columns about the duration of trades for the diagram, or null
- Constructor Detail
  - Metrics
```
public Metrics()
```

Class MetaStatsClient.Metrics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

inclusive

balance

highestBalanceDate

highestBalance

equity

trades

withdrawals

averageTradeLengthInMilliseconds

bestTrade

worstTrade

bestTradePips

worstTradePips

bestTradeDate

bestTradePipsDate

worstTradeDate

worstTradePipsDate

commissions

dailyGain

monthlyGain

equityPercent

expectancy

expectancyPips

gain

geometricHoldingPeriodReturn

interest

longTrades

shortTrades

longWonTrades

shortWonTrades

longWonTradesPercent

shortWonTradesPercent

maxDrawdown

lots

pips

profit

deposits

absoluteGain

profitFactor

sharpeRatio

sortinoRatio

standardDeviationProfit

kurtosisProfit

averageHoldingPeriodReturn

averageWin

averageWinPips

averageLoss

averageLossPips

wonTradesPercent

lostTradesPercent

zScore

probability

daysSinceTradingStarted

currencySummary

dailyGrowth

monthlyAnalytics

closeTradesByWeekDay

openTradesByHour

periods

riskOfRuin

tradeDuration

tradeDurationDiagram

Constructor Detail

Metrics