Skip to main content

Request

{
  "message": "updateLeverage",
  "content": {
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285",
    "leverage": "1"
  }
}
FieldTypeRequiredDescription
messagestringYesupdateLeverage
content.clientRequestIdstringNoClient-generated UUID for correlation
content.leveragestringYesSupported values: 1, 2, 3, 4, 5

Response — Acknowledgment

{
  "resultType": "updateLeverage",
  "data": {
    "statusCode": 202,
    "body": "leverage update in progress, pending approval",
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285"
  }
}
FieldTypeRequiredDescription
resultTypestringYesupdateLeverage
data.statusCodenumberYes202
data.bodystringYesStatus message
data.clientRequestIdstringNoClient-generated UUID for correlation

Response — Confirmation

{
  "resultType": "updateLeverage",
  "data": {
    "statusCode": 200,
    "body": "leverage updated successfully",
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285"
  }
}
FieldTypeRequiredDescription
resultTypestringYesupdateLeverage
data.statusCodenumberYes200
data.bodystringYesStatus message
data.clientRequestIdstringNoClient-generated UUID for correlation

Response — Error

{
  "resultType": "updateLeverage",
  "data": {
    "statusCode": 400,
    "body": "leverage is already set",
    "error": {
      "slug": "BAD_REQUEST",
      "code": "0006"
    },
    "apiQuotaUsed": 1,
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285"
  }
}
{
  "resultType": "updateLeverage",
  "data": {
    "statusCode": 429,
    "body": "api call rate limit exceeded",
    "error": {
      "slug": "TOO_MANY_REQUESTS",
      "code": "0003"
    },
    "apiQuotaUsed": 10001,
    "retryAfterSec": 300,
    "clientRequestId": "2f6635e5-bdab-4fbc-8e2e-21252d2219dc"
  }
}
{
  "resultType": "updateLeverage",
  "data": {
    "statusCode": 500,
    "body": "Internal Server Error",
    "error": {
      "slug": "UPDATE_LEVERAGE_ERROR",
      "code": "7000"
    },
    "apiQuotaUsed": 1,
    "clientRequestId": "2f6635e5-bdab-4fbc-8e2e-21252d2219dc"
  }
}
FieldTypeRequiredDescription
resultTypestringYesupdateLeverage
data.statusCodenumberYesError status (400, 429, 500)
data.bodystringYesError description
data.error.slugstringYesError slug
data.error.codestringYesError code
data.apiQuotaUsednumberNoPresent for quota responses
data.retryAfterSecnumberNoPresent when throttled
data.clientRequestIdstringNoClient-generated UUID for correlation