Trading limit
The credit limit set for your entity, how much of it is currently used, and why the figures are rounded.
The credit limit set for your entity and how much of it your open exposure currently uses.
POST /api/3/user/limit
The limit is per entity, not per account group. There is no
accountGroupUuid parameter — the entity is resolved from the credential, so
one call answers for the whole relationship rather than for one group.
No limit configured is an empty object, not an error. limit comes back as
{} with resultCode: OK. Test for the keys, not for the call failing.
Every figure is rounded, and not by a little. Both amounts are rounded to whole currency units, and the utilisation percentage is quantised to whole percents despite being rendered with two decimals. Use these for monitoring and display; do not reconcile against them.
Request
Sent as a signed body, like every /api/3 call. See
making requests. It takes no parameters of its own.
| Field | Type | Required | Notes |
|---|---|---|---|
nonce | string | Optional | A counter that must increase with each request. An alternative to tonce |
tonce | string | Optional | The current Unix time in microseconds. Send this or nonce |
userUuid | string | Optional | The user the credentials act for. Set automatically from the API key; sending it has no effect |
Response
Carries the resultCode, description and timestamp fields common to every
/api/3 response.
| Field | Type | Notes |
|---|---|---|
limit | Limit | The limit and its utilisation. {} when no limit is configured for your entity |
Limit
| Field | Description |
|---|---|
limitAmount | The credit limit, rounded to whole units |
exposureAmount | Your current exposure against it, rounded to whole units. Computed across the entity, not per account group |
limitUtilisationPercentage | Exposure as a percentage of the limit, as a string. Rendered with two decimals, but the division that produces it is taken to two places before being multiplied by 100 — so it is only ever accurate to the whole percent, and the decimals are always 00. Reported as 0 when the limit is zero |
limitCurrency | The currency the limit is expressed in |
exposureCurrency | The currency the exposure is expressed in. Always the same as limitCurrency — the two are read from one field, so this is never a conversion |
isNetSettlementMode | Whether the entity settles net rather than gross, which changes what counts towards exposure |