Modify price or quantity of a pending order

POST

trade

order

modify

const response = await fetch('/trade/order/modify', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_id: 'your-account-uuid',
    order_id: 'order-to-modify-uuid',
    price: 6100.00
  })
});
const { data: order } = await response.json();
console.log('Modified price:', order.limit_price || order.stop_price);

{
  "code": null,
  "data": {
    "accepted": true,
    "command_id": "0d9f3c1e-7c2a-4b53-9d21-8f6a2e4b7c90",
    "command_type": "ModifyOrder",
    "status": "queued"
  },
  "error": null,
  "success": true
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "UNAUTHORIZED",
  "data": null,
  "error": "Invalid or missing JWT token",
  "success": false
}

{
  "code": "LOCKOUT_ACTIVE",
  "data": null,
  "error": "Account is locked out until 2026-03-12T16:00:00Z (mode: timed, 45 minutes remaining)",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "RATE_LIMITED",
  "data": null,
  "error": "Rate limit exceeded for order submissions. Max 10 requests per second per account. Retry after 0.1 seconds.",
  "rate_limit": {
    "limit": 10,
    "remaining": 0,
    "reset": 1711800125,
    "retry_after": 0.1
  },
  "success": false
}

Body

application/json

Modify order request

Modify the price and/or quantity of a pending limit or stop order. Only pending orders can be modified.

Example

{
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"order_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"price": 6100.00,
"quantity": 2
}

account_id

string<uuid>

required

UUID of the trading account

Example:

"550e8400-e29b-41d4-a716-446655440000"

order_id

string<uuid>

required

UUID of the order to modify

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

price

number<double> | null

New price (limit price for limit orders, stop price for stop orders)

Example:

6100

quantity

integer<int32> | null

New quantity (must be > 0)

Required range: x >= 0

Example:

2

stop_loss

number<double> | null

New planned stop-loss for unfilled entry orders with deferred brackets

Example:

6075

take_profit

number<double> | null

New planned take-profit for unfilled entry orders with deferred brackets

Example:

6125

Response

Modify command accepted

accepted

boolean

required

command_id

string<uuid>

required

command_type

string

required

status

string

required

⌘I

const response = await fetch('/trade/order/modify', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_id: 'your-account-uuid',
    order_id: 'order-to-modify-uuid',
    price: 6100.00
  })
});
const { data: order } = await response.json();
console.log('Modified price:', order.limit_price || order.stop_price);

{
  "code": null,
  "data": {
    "accepted": true,
    "command_id": "0d9f3c1e-7c2a-4b53-9d21-8f6a2e4b7c90",
    "command_type": "ModifyOrder",
    "status": "queued"
  },
  "error": null,
  "success": true
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "UNAUTHORIZED",
  "data": null,
  "error": "Invalid or missing JWT token",
  "success": false
}

{
  "code": "LOCKOUT_ACTIVE",
  "data": null,
  "error": "Account is locked out until 2026-03-12T16:00:00Z (mode: timed, 45 minutes remaining)",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "RATE_LIMITED",
  "data": null,
  "error": "Rate limit exceeded for order submissions. Max 10 requests per second per account. Retry after 0.1 seconds.",
  "rate_limit": {
    "limit": 10,
    "remaining": 0,
    "reset": 1711800125,
    "retry_after": 0.1
  },
  "success": false
}

Platform API

Trade API

Market Data API

Modify price or quantity of a pending order

Body

Example

Response