Get Trading Limit
Get the trading limit for your account.
Domain: Accounts
Request
Section titled “Request”POST https://trade-uk.sandbox.zodiamarkets.com/api/3/user/limitHeaders
Section titled “Headers”| Header | Required | Description |
|---|---|---|
Rest-Key |
yes | API key for authentication |
Rest-Sign |
yes | Calculated API Signature |
| Field | Type | Required | Description |
|---|---|---|---|
tonce |
integer (int64) | yes | The current Unix time in microseconds. |
Responses
Section titled “Responses”200 OK
Section titled “200 OK”Response with Limits
Section titled “Response with Limits”| Field | Type | Required | Description |
|---|---|---|---|
limit |
object | Limit block | |
limit.limitAmount |
integer | Current Limit amount assigned — Default: “2000000” | |
limit.exposureAmount |
integer | Current Exposure (used amount) — Default: 0 | |
limit.isNetSettlementMode |
boolean | Is the remaining limit calculated on net or gross settlement bases — Default: true | |
limit.limitCurrency |
string | Default USD — Default: “USD” | |
limit.exposureCurrency |
string | Default USD — Default: “USD” | |
limit.limitUtilisationPercentage |
integer | Utilization of current limit in percentage terms — Default: 0 | |
limit.overnightLimit |
object | Overnight limit block. Absent when no overnight limit applies. | |
limit.overnightLimit.limitAmount |
integer | Overnight limit. | |
limit.overnightLimit.usageAmount |
integer | Usage counted against the overnight limit. | |
limit.overnightLimit.limitCurrency |
string | Currency of the overnight limit figures. — Default: “USD” | |
limit.overnightLimit.windowStart |
string (date-time) | Start of the period the figures refer to, ISO-8601 UTC. | |
limit.overnightLimit.windowEnd |
string (date-time) | End of the period the figures refer to, ISO-8601 UTC. | |
timestamp |
string | ||
resultCode |
string |
Response Without Limits
Section titled “Response Without Limits”| Field | Type | Required | Description |
|---|---|---|---|
limit |
object | ||
timestamp |
string | ||
resultCode |
string |
400 Bad Request
Section titled “400 Bad Request”| Field | Type | Required | Description |
|---|---|---|---|
resultCode |
string | ||
timestamp |
string |
401 Unauthorized
Section titled “401 Unauthorized”| Field | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ||
resultCode |
string |
403 Forbidden
Section titled “403 Forbidden”| Field | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ||
resultCode |
string |
404 Not Found
Section titled “404 Not Found”| Field | Type | Required | Description |
|---|---|---|---|
apiVersion |
string | ||
error |
string | ||
timestamp |
integer | Default: 0 |
500 Internal Server Error
Section titled “500 Internal Server Error”| Field | Type | Required | Description |
|---|---|---|---|
resultCode |
string | ||
timestamp |
string |
