User Account Auto Liq Create

POST

https://live.tradovateapi.com/v1/userAccountAutoLiq/create

POST

/v1/userAccountAutoLiq/create

curl -X POST https://live.tradovateapi.com/v1/userAccountAutoLiq/create \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Successful

{
  "id": 1,
  "changesLocked": true,
  "marginPercentageAlert": 1.1,
  "dailyLossPercentageAlert": 1.1,
  "dailyLossAlert": 1.1,
  "marginPercentageLiqOnly": 1.1,
  "dailyLossPercentageLiqOnly": 1.1,
  "dailyLossLiqOnly": 1.1,
  "marginPercentageAutoLiq": 1.1,
  "dailyLossPercentageAutoLiq": 1.1,
  "dailyLossAutoLiq": 1.1,
  "weeklyLossAutoLiq": 1.1,
  "flattenTimestamp": "2024-01-15T09:30:00Z",
  "trailingMaxDrawdown": 1.1,
  "trailingMaxDrawdownLimit": 1.1,
  "trailingMaxDrawdownMode": "EOD",
  "dailyProfitAutoLiq": 1.1,
  "weeklyProfitAutoLiq": 1.1,
  "doNotUnlock": true,
  "steppedCooldown": {
    "steps": [
      {
        "stepNumber": 1,
        "stepDistance": 1.1,
        "cooldownMinutes": 1
      }
    ],
    "terminalStep": {
      "stepNumber": 1,
      "stepDistance": 1.1
    }
  },
  "steppedUnlimited": true,
  "fixedKillFloor": 1.1
}

Create a new auto-liquidation configuration for an account.

This endpoint creates a UserAccountAutoLiq entity, which holds an account’s post-trade auto-liquidation settings, including trailingMaxDrawdownMode. See Drawdown Modes for more information.

Most integrations set auto-liquidation configuration at account creation (via the postTradeRisk/defaultAutoLiq fields) or by calling updateUserAutoLiq, rather than this raw entity operation.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

idlongOptional

changesLockedbooleanOptional

Changes Locked

marginPercentageAlertdoubleOptional

Margin % for an Alert

dailyLossPercentageAlertdoubleOptional

Daily Loss % for an Alert

dailyLossAlertdoubleOptional

$ Daily Loss for an Alert

marginPercentageLiqOnlydoubleOptional

Margin % for an Liq Only

dailyLossPercentageLiqOnlydoubleOptional

Daily Loss % for an Liq Only

dailyLossLiqOnlydoubleOptional

$ Daily Loss for an Liq Only

marginPercentageAutoLiqdoubleOptional

Margin % for an Auto-Liq

dailyLossPercentageAutoLiqdoubleOptional

Daily Loss % for an AutoLiq

dailyLossAutoLiqdoubleOptional

$ Daily Loss for an Auto-Liq

weeklyLossAutoLiqdoubleOptional

$ Weekly Loss for an Auto-Liq

flattenTimestampdatetimeOptional

Flatten & Cancel

trailingMaxDrawdowndoubleOptional

$ Trailing Max Drawdown

trailingMaxDrawdownLimitdoubleOptional

$ Trailing Max Drawdown Limit

trailingMaxDrawdownModeenumOptional

EOD, RealTime, SteppedEOD, SteppedRealTime

Allowed values:

dailyProfitAutoLiqdoubleOptional

$ Daily Profit for an Auto-Liq

weeklyProfitAutoLiqdoubleOptional

$ Weekly Profit for an Auto-Liq

doNotUnlockbooleanOptional

Do not automatically unlock account if triggered

steppedCooldownobjectOptional

steppedUnlimitedbooleanOptional

fixedKillFloordoubleOptional

Response

UserAccountAutoLiq