Skip to main content
POST
Edit Order

Authorizations

Authorization
string
header
required

A bearer token signed using your API Key Secret, see Creating API Keys section of our docs for more information. See Scope & Permissions for the permission each endpoint requires.

Body

application/json
order_id
string
required

The ID of the order.

price
string
required

The update price of the order.

Example:

"19000.00"

size
string
required

The updated size of the order.

Example:

"0.001"

attached_order_configuration
object

The configuration of the attached order. Only TriggerBracketGtc, LimitLimitGtc or StopLimitStopLimitGtc are eligible.

cancel_attached_order
boolean

Drops both the legs of TP/SL, order becomes a simple limit order.

Example:

"true"

stop_price
string

The updated stop price of the order. Only applicable for editing TP/SL or SL orders.

Example:

"17000.00"

average_entry_price
string

The average entry price of the position. Used for estimated PnL

Example:

"18000.00"

Response

A successful response.

success
boolean
required

Whether the order edit request was placed.

Example:

true

errors
object[]