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

Headers

AuthorizationstringRequired

Request

This endpoint expects an object.
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

Response

OK

accountstringOptional

Account identifier (user’s account address)

avg_fill_pricestringOptional

Average fill price of the order

cancel_reasonstringOptional

Reason for order cancellation if it was closed by cancel

client_idstringOptional

Client id passed on order creation

created_atintegerOptional

Order creation time

flagslist of enumsOptional

Order flags, allow flag: REDUCE_ONLY

Allowed values:
idstringOptional

Unique order identifier

instructionenumOptional

OrderInstruction (GTC, IOC, POST_ONLY)

Allowed values:
last_updated_atintegerOptional

Order last update time. No changes once status=CLOSED

marketstringOptional

Market to which order belongs

pricestringOptional

Order price. 0 for MARKET orders

published_atintegerOptional

Order published to the client time

received_atintegerOptional

Order received from the client time

remaining_sizestringOptional

Remaining size of the order

request_infoobjectOptional

Request info for modify order

seq_nointegerOptional

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.

sideenumOptional

Order side

Allowed values:
sizestringOptional

Order size

statusenumOptional

Order status

Allowed values:
stpenumOptional

Self Trade Prevention mode (EXEPIRE_MAKER, EXPIRE_TAKER, EXPIRE_BOTH)

Allowed values:
timestampintegerOptional

Order signature timestamp

trigger_pricestringOptional

Trigger price for stop order

typeenumOptional

Order type

Errors