Skip to content

Drawdown event#

About#

Drawdown event

Fields#

Name Type Required Description
sequenceNumber number Yes event unique sequence number
accountId string Yes metaApi account id
trackerId string Yes drawdown tracker id
startBrokerTime string(datetime) Yes drawdown tracking period start time in broker timezone (in YYYY-MM-DD HH:mm:ss.SSS format)
endBrokerTime string(datetime) drawdown tracking period end time in broker timezone (in YYYY-MM-DD HH:mm:ss.SSS format)
period string Yes drawdown tracking period. One of day, date, week, week-to-date, month, month-to-date, quarter, quarter-to-date, year, year-to-date, lifetime
brokerTime string(datetime) Yes drawdown threshold exceeded event time in broker timezone (in YYYY-MM-DD HH:mm:ss.SSS format)
absoluteDrawdown number Yes absolute drawdown value which was observed when the drawdown threshold was exceeded
relativeDrawdown number Yes relative drawdown value which was observed when the drawdown threshold was exceeded

Example#

{
  "sequenceNumber": 1,
  "accountId": "105646d8-8c97-4d4d-9b74-413bd66cd4ed",
  "trackerId": "ABCD",
  "startBrokerTime": "2020-08-24 00:00:00.000",
  "endBrokerTime": "2020-08-24 00:00:00.000",
  "period": "day",
  "brokerTime": "2020-08-24 00:00:00.000",
  "absoluteDrawdown": 1.1,
  "relativeDrawdown": 0.1
}

Usages#