Skip to content

Account strategy stop out#

About#

Account strategy stop out

Fields#

Name Type Required Description
strategy StrategyIdAndName strategy which was stopped out if the stopout is at strategy-level
partial boolean Yes flag indicating that stopout is partial
reason string Yes stopout reason. Formed by concatenation of risk limit type and apply to values. One of year-balance-difference, year-to-date-balance-difference, quarter-balance-difference, quarter-to-date-balance-difference, month-balance-difference, month-to-date-balance-difference, week-balance-difference, week-to-date-balance-difference, day-balance-difference, date-balance-difference, lifetime-balance-difference, year-balance-minus-equity, year-to-date-balance-minus-equity, quarter-balance-minus-equity, quarter-to-date-balance-minus-equity, month-balance-minus-equity, month-to-date-balance-minus-equity, week-balance-minus-equity, week-to-date-balance-minus-equity, day-balance-minus-equity, date-balance-minus-equity, lifetime-balance-minus-equity, year-equity-difference, year-to-date-equity-difference, quarter-equity-difference, quarter-to-date-equity-difference, month-equity-difference, month-to-date-equity-difference, week-equity-difference, week-to-date-equity-difference, day-equity-difference, date-equity-difference, lifetime-equity-difference
reasonDescription string Yes human-readable description of the stopout reason
closePositions boolean flag indicating if positions should be closed
stoppedAt string(datetime) Yes time the strategy was stopped at (in ISO format)
stoppedTill string(datetime) time the strategy is stopped till (in ISO format)

Example#

{
  "strategy": {
    "id": "GtyH",
    "name": "Demo strategy"
  },
  "partial": true,
  "reason": "day-balance-difference",
  "reasonDescription": "daily realized loss exceeded maximum allowed value",
  "stoppedAt": "2020-08-24T00:00:00.000Z",
  "stoppedTill": "2020-08-24T10:00:00.000Z"
}

Usages#