Production API ReferenceOrders

Modify order

Modify an existing open order by changing its price and/or size. The modified order maintains its original order ID.

Path parameters

order_idstringRequired
Order Id

Request

Modify Order Request
idstringRequired
Order ID to be modified
marketstringRequired
Market for which order is modified
pricestringRequired
Existing or modified price of the order
sidestringRequired
Existing side of the order
signaturestringRequired
Order Payload signed with STARK Private Key
signature_timestampintegerRequired
Timestamp of order creation, used for signature verification
sizestringRequired
Existing or modified size of the order
typestringRequired
Existing type of the order
on_behalf_of_accountstringOptional
ID corresponding to the configured isolated margin account. Only for isolated margin orders

Response

OK
accountstring or null
Paradex Account
avg_fill_pricestring or null
Average fill price of the order
cancel_reasonstring or null
Reason for order cancellation if it was closed by cancel
client_idstring or null
Client order id provided by the client at order creation
created_atinteger or null
Order creation time
flagslist of enums or null

Order flags, allow flag: REDUCE_ONLY

Allowed values:
idstring or null
Unique order identifier generated by Paradex
instructionenum or null
Execution instruction for order matching
Allowed values:
last_updated_atinteger or null

Order last update time. No changes once status=CLOSED

marketstring or null
Market
pricestring or null
Order price. 0 for MARKET orders
published_atinteger or null
Timestamp in milliseconds when order was sent to the client
received_atinteger or null
Timestamp in milliseconds when order was received by API service
remaining_sizestring or null
Remaining size of the order
request_infoobject or null
Additional request information for orders
seq_nointeger or null

Unique increasing number (non-sequential) that is assigned to this order update and changes on every order update. Can be used to deduplicate multiple feeds. WebSocket and REST responses use independently generated seq_no per event.

sideenum or null
Order side
Allowed values:
sizestring or null
Order size
statusenum or null
Order status
Allowed values:
stpenum or null
Self Trade Prevention mode
Allowed values:
timestampinteger or null
Order signature timestamp
trigger_pricestring or null
Trigger price for stop order
typeenum or null
Order type

Errors