Skip to Content

Modify Single Order

This API allows you to modify an existing order without waiting for the exchange response.

USE CASE

Modify pending orders in quick succession and confirm each change on the General WebSocket or order book.

Details

  • Same JSON attributes as synchronous modify. PATCH to /api/v3/orders/async.
  • For /sync vs /async behavior, queuing, 10 OPS, id_fyers and hosts, see the Order Placement Guide.
  • Modifying orders needs an app with the Order Placement permission. The body rules are the same as the sync Modify Single Order API.
  • An HTTP 200 response only means the request was queued. It does not confirm that the order was modified.
  • The response returns id_fyers and not the order id. Use id_fyers to match the General WebSocket updates or the order book.
  • The queue sends requests on at most 10 orders per second.
  • Prices must be multiples of the symbol tick size, and quantity must follow the lot-size rules.
  • Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Response Attributes - Immediate (async)

AttributeData TypeDescription
sstringok / error
codeintResponse code
messagestringStatus message
id_fyersstringFyers id for the async modify request. id (order ref) is not returned in this immediate response.
Last updated on