Post-Trade Risk
Managing Post-Trade Risk is another place where our system shines. We allow our partners to set Post-Trade risk at the time of account creation. There are two ways to set Post-Trade risk:
- At account creation. You can configure Post-Trade risk by providing a
postTradeRiskobject on the account object. - Any time you desire by using
userAccountAutoLiq/update.
Structure
Both the creation-based post-trade risk management as well as the update-based post-trade risk management have the same basic JSON request structure. The userAccountAutoLiq/update and postTradeRisk fields should be a JSON object such as the following:
Response
Here is a table of all of the settings you can define.
Note: You don’t need to assign a value for every field - omitting a field will simply ignore calculations for that liquidation type. For example, an account without a dailyLossAutoLiq has no daily loss limit applied.
| Field | Description |
|---|---|
| marginPercentageAlert | Sends an Alert to the permitted user when % margin is reached. |
| dailyLossPercentageAlert | Sends an Alert to the permitted user when this % of the day’s starting balance is reached |
| dailyLossAlert | Sends an Alert to the permitted user when this dollar value daily loss is reached |
| marginPercentageLiqOnly | Sets an account to Liquidate Only mode when % margin is reached (in |
| dailyLossPercentageLiqOnly | Sets an account to Liquidate Only mode when daily loss reaches this % of the day’s starting balance. |
| dailyLossLiqOnly | Sets an account to Liquidate Only mode when this dollar value daily loss is reached. |
| marginPercentageAutoLiq | Automatically liquidate an account that reaches this % of margin. |
| dailyLossPercentageAutoLiq | Automatically liquidate an account that reaches this % of daily loss from the day’s starting balance. Unlocks at the next market open. |
| dailyLossAutoLiq | Automatically liquidate an account that reaches this dollar value daily loss. Unlocks at the next market open |
| weeklyLossAutoLiq | Automatically liquidate an account that reaches this dollar value weekly loss. Unlocks at market open on Sunday. |
| flattenTimestamp | Force an account to flatten and cancel open positions at this time. *Note: this setting is for a specific date-time, not a repeating time. Once flattened, nothing prevents a user from re-opening positions.* |
| trailingMaxDrawdown | Specify the maximum loss the account can sustain before being auto-liquidated, trailing up as the account makes profit. |
| trailingMaxDrawdownLimit | Specify an equity level at which the trailing behavior stops. For example, if set to 50,000 account, the trailing drawdown level will not increase beyond $50,100. |
| trailingMaxDrawdownMode | Specify the behavior of trailing calculations. This can be "EOD" or "RealTime". When in "EOD" mode, the trailing level will only change at end-of-day (4PM CT). When in "RealTime" mode, the trailing level will change in real-time, even when unrealized profit is made. |
| dailyProfitAutoLiq | You can specify a dollar-value daily profit amount to liquidate an account at. Accounts locked this way will unlock at the next market open. |
| weeklyProfitAutoLiq | Specify a dollar-value weekly profit amount to liquidate this account. Accounts locked this way will unlock at the next Sunday open (5PM CT). |
| doNotUnlock | If this setting is set to true, this account will not unlock from the liquidation conditions listed above. This means even a daily loss level will lock an account semi-permanently (you the partner can still reset or manually unlock the account) |

