Documentation Index
Fetch the complete documentation index at: https://docs.rails.xyz/llms.txt
Use this file to discover all available pages before exploring further.
Request
{
"message": "updateLeverage",
"content": {
"clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285",
"market": "ETH-USD",
"leverage": "1"
}
}
| Field | Type | Required | Description |
|---|
message | string | Yes | updateLeverage |
content.clientRequestId | string | No | Client-generated UUID for correlation |
content.market | string | No | Market name, only required when connecting with market=ALL |
content.leverage | string | Yes | Supported 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"
},
"market": "ETH-USD"
}
| Field | Type | Required | Description |
|---|
resultType | string | Yes | updateLeverage |
data.statusCode | number | Yes | 202 |
data.body | string | Yes | Status message |
data.clientRequestId | string | No | Client-generated UUID for correlation |
market | string | Yes | Market name |
Response — Confirmation
{
"resultType": "updateLeverage",
"data": {
"statusCode": 200,
"body": "leverage updated successfully",
"clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285"
},
"market": "ETH-USD"
}
| Field | Type | Required | Description |
|---|
resultType | string | Yes | updateLeverage |
data.statusCode | number | Yes | 200 |
data.body | string | Yes | Status message |
data.clientRequestId | string | No | Client-generated UUID for correlation |
market | string | Yes | Market name |
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"
}
}
| Field | Type | Required | Description |
|---|
resultType | string | Yes | updateLeverage |
data.statusCode | number | Yes | Error status (400, 429, 500) |
data.body | string | Yes | Error description |
data.error.slug | string | Yes | Error slug |
data.error.code | string | Yes | Error code |
data.apiQuotaUsed | number | No | Present for quota responses |
data.retryAfterSec | number | No | Present when throttled |
data.clientRequestId | string | No | Client-generated UUID for correlation |
