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": "modifyOrder",
"content": {
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
"market": "ETH-USD",
"orderId": "01KHPJAA0QBAJEXQJ941F7SWW7",
"price": "1999.00",
"quantity": "1.00"
}
}
| Field | Type | Required | Description |
|---|
message | string | Yes | modifyOrder |
content.clientRequestId | string | No | Client-generated UUID for correlation |
content.market | string | No | Market name, only required when connecting with market=ALL |
content.orderId | string | Yes | Unique identifier for the original order |
content.price | string | Yes | New order price |
content.quantity | string | Yes | New order quantity |
Response — Acknowledgment
{
"resultType": "modifyOrder",
"market": "ETH-USD",
"data": {
"statusCode": 202,
"body": "modifying order",
"order": {
"market": "ETH-USD",
"orderId": "01KHPJAA0QBAJEXQJ941F7SWW7",
"orderType": "sell",
"tradeType": "limit",
"price": "1999.00",
"quantity": "1.00",
"filledQuantity": "0",
"leverage": "10",
"createdAt": 1771357677591,
"updatedAt": 1771357677701,
"orderStatus": "modifying",
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
"postOnly": false
},
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
"apiQuotaUsed": 5
}
}
| Field | Type | Required | Description |
|---|
resultType | string | Yes | modifyOrder |
market | string | No | Market name, present when connected with market=ALL |
data.statusCode | number | Yes | 202 |
data.body | string | Yes | Status message |
data.order.market | string | Yes | Market name |
data.order.orderId | string | Yes | Unique identifier for the original order |
data.order.orderType | string | Yes | Order side: buy or sell |
data.order.tradeType | string | Yes | Order type: limit or market |
data.order.price | string | Yes | New price used |
data.order.quantity | string | Yes | New remaining quantity |
data.order.filledQuantity | string | Yes | New filled quantity |
data.order.leverage | string | Yes | Leverage used at order modification |
data.order.createdAt | number | Yes | Milliseconds since epoch |
data.order.updatedAt | number | Yes | Milliseconds since epoch |
data.order.orderStatus | string | Yes | modifying |
data.order.clientRequestId | string | No | Client-generated UUID for correlation |
data.order.postOnly | boolean | Yes | Maker-only creation flag, same as the original order |
data.clientRequestId | string | No | Client-generated UUID for correlation |
data.apiQuotaUsed | number | Yes | API quota consumed |
Response — Original Order Modified Notice
{
"resultType": "modifyOrder",
"market": "ETH-USD",
"data": {
"statusCode": 200,
"body": "original order modified",
"order": {
"market": "ETH-USD",
"orderId": "01KHPJAA0QBAJEXQJ941F7SWW7",
"orderType": "sell",
"tradeType": "limit",
"price": "2000.00",
"quantity": "2.00",
"filledQuantity": "0",
"leverage": "10",
"createdAt": 1771357677591,
"updatedAt": 1771357677701,
"orderStatus": "modified",
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
"postOnly": false
},
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
}
}
| Field | Type | Required | Description |
|---|
resultType | string | Yes | modifyOrder |
market | string | No | Market name, present when connected with market=ALL |
data.statusCode | number | Yes | 200 |
data.body | string | Yes | Status message |
data.order.market | string | Yes | Market name |
data.order.orderId | string | Yes | Unique identifier for the original order |
data.order.orderType | string | Yes | Order side: buy or sell |
data.order.tradeType | string | Yes | Order type: limit or market |
data.order.price | string | Yes | Original price used |
data.order.quantity | string | Yes | Original remaining quantity |
data.order.filledQuantity | string | Yes | Original filled quantity |
data.order.leverage | string | Yes | Leverage used at order modification |
data.order.createdAt | number | Yes | Milliseconds since epoch |
data.order.updatedAt | number | Yes | Milliseconds since epoch |
data.order.orderStatus | string | Yes | modified |
data.order.clientRequestId | string | No | Client-generated UUID for correlation |
data.order.postOnly | boolean | Yes | Maker-only creation flag, same as the original order |
data.clientRequestId | string | No | Client-generated UUID for correlation |
Response — New Order Pending Notice
{
"resultType": "modifyOrder",
"market": "ETH-USD",
"data": {
"statusCode": 200,
"body": "new order created, pending acceptance",
"order": {
"market": "ETH-USD",
"orderId": "01KHPJD4JARPZJVN44BKVMMM66",
"orderType": "sell",
"tradeType": "limit",
"price": "1999",
"quantity": "1",
"filledQuantity": "0",
"leverage": "10",
"createdAt": 1771357770314,
"updatedAt": 1771357770314,
"orderStatus": "pending",
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
"postOnly": false
},
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
}
}
| Field | Type | Required | Description |
|---|
resultType | string | Yes | modifyOrder |
market | string | No | Market name, present when connected with market=ALL |
data.statusCode | number | Yes | 200 |
data.body | string | Yes | Status message |
data.order.market | string | Yes | Market name |
data.order.orderId | string | Yes | New unique identifier for the modified order |
data.order.orderType | string | Yes | Order side: buy or sell |
data.order.tradeType | string | Yes | Order type: limit or market |
data.order.price | string | Yes | New price used |
data.order.quantity | string | Yes | New remaining quantity |
data.order.filledQuantity | string | Yes | New filled quantity |
data.order.leverage | string | Yes | Leverage used at order modification |
data.order.createdAt | number | Yes | Milliseconds since epoch |
data.order.updatedAt | number | Yes | Milliseconds since epoch |
data.order.orderStatus | string | Yes | pending |
data.order.clientRequestId | string | No | Client-generated UUID for correlation |
data.order.postOnly | boolean | Yes | Maker-only creation flag, same as the original order |
data.clientRequestId | string | No | Client-generated UUID for correlation |
Response — Creation Confirmation
{
"resultType": "createOrder",
"market": "ETH-USD",
"data": {
"statusCode": 200,
"body": "order accepted",
"order": {
"market": "ETH-USD",
"orderId": "01KHPJD4JARPZJVN44BKVMMM66",
"orderType": "sell",
"tradeType": "limit",
"price": "1999",
"quantity": "1",
"filledQuantity": "0",
"leverage": "10",
"createdAt": 1771357770314,
"updatedAt": 1771357770314,
"orderStatus": "active",
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
"postOnly": false
},
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
}
}
| Field | Type | Required | Description |
|---|
resultType | string | Yes | createOrder |
market | string | No | Market name, present when connected with market=ALL |
data.statusCode | number | Yes | 200 |
data.body | string | Yes | Status message |
data.order.market | string | Yes | Market name |
data.order.orderId | string | Yes | New unique identifier for the modified order |
data.order.orderType | string | Yes | Order side: buy or sell |
data.order.tradeType | string | Yes | Order type: limit or market |
data.order.price | string | Yes | New price used |
data.order.quantity | string | Yes | New remaining quantity |
data.order.filledQuantity | string | Yes | New filled quantity |
data.order.leverage | string | Yes | Leverage used at order modification |
data.order.createdAt | number | Yes | Milliseconds since epoch |
data.order.updatedAt | number | Yes | Milliseconds since epoch |
data.order.orderStatus | string | Yes | active |
data.order.clientRequestId | string | No | Client-generated UUID for correlation |
data.order.postOnly | boolean | Yes | Maker-only creation flag, same as the original order |
data.clientRequestId | string | No | Client-generated UUID for correlation |
Response — Error
{
"resultType": "createOrder",
"market": "ETH-USD",
"data": {
"statusCode": 400,
"body": "maximum open orders count of 80 reached",
"order": {
"market": "ETH-USD",
"orderId": "01KHPJD4JARPZJVN44BKVMMM66",
"orderType": "sell",
"tradeType": "limit",
"price": "1999",
"quantity": "1",
"filledQuantity": "0",
"leverage": "10",
"createdAt": 1771357770314,
"updatedAt": 1771357770314,
"orderStatus": "rejected",
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
"postOnly": false
},
"error": {
"slug": "CREATE_ORDER_ERROR",
"code": "1000"
},
"apiQuotaUsed": 1,
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
}
}
{
"resultType": "createOrder",
"market": "ETH-USD",
"data": {
"statusCode": 408,
"body": "order activation timeout, pending order rejected",
"error": {
"slug": "CREATE_ORDER_ERROR",
"code": "1000"
},
"apiQuotaUsed": 1,
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
}
}
{
"resultType": "modifyOrder",
"market": "ETH-USD",
"data": {
"statusCode": 429,
"body": "api call rate limit exceeded",
"error": {
"slug": "TOO_MANY_REQUESTS",
"code": "0003"
},
"apiQuotaUsed": 10001,
"retryAfterSec": 300,
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
}
}
{
"resultType": "modifyOrder",
"market": "ETH-USD",
"data": {
"statusCode": 500,
"body": "Internal Server Error",
"error": {
"slug": "MODIFY_ORDER_ERROR",
"code": "3000"
},
"apiQuotaUsed": 1,
"clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
}
}
| Field | Type | Required | Description |
|---|
resultType | string | Yes | modifyOrder or createOrder |
market | string | No | Market name, present when connected with market=ALL |
data.statusCode | number | Yes | Error status (400, 408, 429, 500) |
data.body | string | Yes | Error description |
data.order.market | string | No | Market name |
data.order.orderId | string | No | Unique identifier for the order (original or new) |
data.order.orderType | string | No | Order side: buy or sell |
data.order.tradeType | string | No | Order type: limit or market |
data.order.price | string | No | Price used (original or new) |
data.order.quantity | string | No | Remaining quantity (original or new) |
data.order.filledQuantity | string | No | Filled quantity (original or new) |
data.order.leverage | string | No | Leverage used at order modification |
data.order.createdAt | number | No | Milliseconds since epoch |
data.order.updatedAt | number | No | Milliseconds since epoch |
data.order.orderStatus | string | No | rejected |
data.order.clientRequestId | string | No | Client-generated UUID for correlation |
data.order.postOnly | boolean | No | Maker-only creation flag, same as the original order |
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 |