v1

latestOpenAPI 3.0.12026-07-2683220192.3 KB
Orders

Modify Order

Modify an existing order in the marketplace. Allows changing price, quantity, time in force, and other parameters.

post/v1/order/{orderId}/modify

Path parameters

orderIdstring required

Exchange-assigned Order ID to modify

Request body

marketSlugstring

Unique market slug for the order being modified

quantitynumber double

Order quantity in contracts. Supports decimal quantities on markets whose minimumTradeQty is less than 1.

tif'TIME_IN_FORCE_DAY' | 'TIME_IN_FORCE_GOOD_TILL_CANCEL' | 'TIME_IN_FORCE_IMMEDIATE_OR_CANCEL' | 'TIME_IN_FORCE_GOOD_TILL_TIME' | 'TIME_IN_FORCE_FILL_OR_KILL'

TimeInForce specifies how long the order remains in effect.

participateDontInitiateboolean

Order must rest on the book prior to matching (maker only)

goodTillTimestring

Good till time for orders with TIME_IN_FORCE_GOOD_TILL_DATE

Example request

{
  "price": {
    "value": "123.45"
  }
}

Response

Order modified successfully

ModifyOrderResponse required

Response for order modification (empty on success)