Edit order

Limit: 10 request per 1 second

PUT /v1/order

Edit a pending order by order_id. Only the order_price or order_quantity can be amended.

Note: This endpoint requires trading scope in orderly key.

PUT /v1/order

Edit order

cURL

curl --request PUT \
  --url https://api.orderly.org/v1/order \
  --header 'Content-Type: application/json' \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>' \
  --data '
{
  "order_id": "<string>",
  "symbol": "<string>",
  "order_type": "<string>",
  "side": "<string>",
  "client_order_id": "<string>",
  "order_price": 123,
  "order_quantity": 123,
  "order_amount": 123,
  "reduce_only": true,
  "visible_quantity": 123,
  "order_tag": "<string>"
}
'

200

{
  "success": true,
  "data": {
    "status": "EDIT_SENT"
  },
  "timestamp": 1702989203989
}

Headers

orderly-timestamp · string · required

Timestamp of the signed request in milliseconds.

orderly-account-id · string · required

Account ID of the authenticated account.

orderly-key · string · required

Public orderly key used to sign the request.

orderly-signature · string · required

Signature of the request payload generated with the orderly key.

Body

application/json

order_id · string · required

symbol · string · required

order_type · string · required

side · string · required

client_order_id · string

order_price · number

order_quantity · number

order_amount · number

reduce_only · boolean

visible_quantity · number

order_tag · string

Optional tag for the order. Supports two formats:

• Referral code: plain string (e.g., REFERRAL2026) - overrides referral relationship
• Order tag fee config: enum:<enum_id> (e.g., enum:STRATEGY_DCA) - adds fee on top of existing fees, preserves referral Max length: 36 characters. Cannot be modified after order placement.

Response

200 - application/json

OK

success · boolean · required

Indicates whether the request was successful.

Example:

true

data · object · required

Show child attributes

timestamp · integer

Server timestamp in milliseconds.

Example:

1702989203989