Sign in
latestOpenAPI 3.0.12026-08-16171142480.4 KB

ff1699330afa

Account API

Get an account risk limit

get/rest/api/v1/accounts/{accountId}/riskLimits/{riskLimitId}

Path parameters

accountIdstring uuid required
riskLimitIdstring uuid required

Response

OK

absoluteRiskLimitnumber

Enter an absolute risk limit in account currency. Set to 0 to deactivate.

accountIdstring uuid

You have to set it during resource creation, after that, it is only read-only

activeboolean
closeAllOpenPositionsboolean

If set to 'true', all positions will be closed immediately when the primary risk limit is reached. If set to 'false', new trades will not be opened when the primary limit is reached, but the fallback limits become active as a secondary safety measure.

copierIdstring uuid

You have to set it during resource creation, after that, it is only read-only

fallbackAbsoluteRiskLimitnumber

Fallback absolute risk limit in account currency. Only applies when closeAllOpenPositions is false. When this limit is reached, all positions will be closed. Set to 0 to deactivate.

fallbackRelativeRiskLimitnumber

Fallback relative risk limit in account currency. Only applies when closeAllOpenPositions is false. When this limit is reached, all positions will be closed. Set to 0 to deactivate.

fallbackRiskLimitnumber

Fallback risk limit (percentage). Only applies when closeAllOpenPositions is false. When this limit is reached, all positions will be closed. Set to 0 to deactivate.

fulfillSecondsinteger

If set to 5, it means that if the limit is reached and stays over the limit for 5 seconds, the risk limit will be activated; otherwise, the limit will remain deactivated

idstring uuid
relativeRiskLimitnumber

Enter an relative risk limit in account currency. Set to 0 to deactivate.

resetTimestring date-time

ISO 8601. Set the reset time for calculation (see riskType). Only used for 1-3 risk type. Only the time is considered, and the date is ignored.

riskLimitnumber required

0.215 for 21.5% (set to 0 to deactivate)