Skip to Content

Modify Single Order

This API allows you to modify an existing order.

USE CASE

Change the price, quantity or trigger price of an order that is still pending.

Details

  • This allows the user to modify a pending order. User can provide parameters which needs to be modified. In case a particular parameter has not been provided, the original value will be considered.
  • Modifying orders needs an app with the Order Placement permission.
  • Only pending orders can be modified. The id of the order and its type are always required.
  • Prices must be multiples of the symbol tick size, and quantity must follow the lot-size rules.
  • Modify requests count towards the limit of 10 orders per second shared with placing and cancelling. Requests beyond it are rejected.
  • To cancel only a linked Take Profit or Stop Loss, pass null for takeProfit or stopLoss. Pass both as null to cancel both.
  • If the response code is 201, the request was made but not acknowledged. Check the order book before sending it again.
  • For order types, product types, validations and sync vs async behaviour, refer to the Order Placement Guide.
  • When order rate limiting is triggered, the API returns 429 Too Many Requests.
  • Retry timing is provided through response headers, not in the response body.
  • Retry-After — Wait time before retrying, in seconds
  • X-Retry-After-Ms — Wait time before retrying, in milliseconds
  • Use the retry interval returned in the response headers before sending another order request.
  • Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Request Attributes

AttributeData TypeDescription
id*string
  • Mandatory.
  • Eg: 119031547242
type*intMandatory.
limitPricefloatMandatory. Only incase of Limit/ Stoplimit orders
stopPricefloatMandatory. Only incase of Stop/ Stoplimit orders
qtyintMandatory. Incase you want to modify the quantity
disclosedQtyintDisclosed quantity (Optional)

Response Attributes

AttributeData TypeDescription
sstringok / error
codeint
  • This is the code to identify specific responses
  • If 201 comes in code it implies that order request has been made but no acknowledgement has been received in this case check orderbook before placing order
messagestring
  • Message to clarify the request status.
  • Eg: Successfully modified order
idstring
  • The order number of the modified order
  • Eg: 119031547242
Last updated on