Period statistics#
About#
Period statistics
Fields#
| Name | Type | Required | Description |
|---|---|---|---|
| startBrokerTime | string(datetime) | Yes | period start time in broker timezone (in YYYY-MM-DD HH:mm:ss.SSS format) |
| endBrokerTime | string(datetime) | period end time in broker timezone (in YYYY-MM-DD HH:mm:ss.SSS format) | |
| period | string | Yes | period length. One of day, date, week, week-to-date, month, month-to-date, quarter, quarter-to-date, year, year-to-date, lifetime |
| initialBalance | number | Yes | balance at period start time |
| maxDrawdownTime | string(datetime) | time max drawdown was observed at in broker timezone (in YYYY-MM-DD HH:mm:ss.SSS format) | |
| maxAbsoluteDrawdown | number | the value of maximum absolute drawdown observed. Absolute drawdown is expressed in account currency | |
| maxRelativeDrawdown | number | the value of maximum relative drawdown observed. A fraction of 1 | |
| maxProfitTime | string(datetime) | time max profit was observed at in broker timezone (in YYYY-MM-DD HH:mm:ss.SSS format) | |
| maxAbsoluteProfit | number | the value of maximum absolute profit observed. Absolute profit is expressed in account currency | |
| maxRelativeProfit | number | the value of maximum relative profit observed. A fraction of 1 | |
| thresholdExceeded | boolean | Yes | the flag indicating that max allowed total drawdown was exceeded |
| exceededThresholdType | string | type of the exceeded threshold. One of profit, drawdown |
|
| balanceAdjustment | number | balance adjustment applied to equity for tracking drawdown/profit | |
| tradeDayCount | number | count of days when trades were performed during the period |
Example#
{
"startBrokerTime": "2020-08-24 00:00:00.000",
"endBrokerTime": "2020-08-25 00:00:00.000",
"period": "day",
"initialBalance": 10000,
"maxDrawdownTime": "2020-08-25 00:00:00.000",
"maxAbsoluteDrawdown": 1000,
"maxRelativeDrawdown": 0.1,
"maxAbsoluteProfit": 500,
"maxRelativeProfit": 0.05,
"thresholdExceeded": true,
"exceededThresholdType": "drawdown"
}