Sign in
Orders

modify pending order

The api allows you modify pending order in orderbook. The fields that can be modified are price, quantity, order type & validity.

put/orders/{order-id}

Path parameters

order-idstring required

Headers

access-tokenstring required

Request body

dhanClientIdstring

User specific identification generated by Dhan

orderIdstring

Order specific identification generated by Dhan

orderType'LIMIT' | 'MARKET' | 'STOP_LOSS' | 'STOP_LOSS_MARKET'
Enum ValuesDescription
LIMITFor Limit Order types
MARKETFor market Order types
STOP_LOSSFor Stop Loss Limit orders
STOP_LOSS_MARKETFor Stop Loss Market orders
legName'ENTRY_LEG' | 'STOP_LOSS_LEG' | 'TARGET_LEG' | 'NA'

Order leg where modification is to be done

quantityinteger

Number of shares for the order

pricenumber float

Price at which order is placed

disclosedQuantityinteger

Number of shares visible (Keep more than 30% of quantity)

triggerPricenumber float

Price at which the order is triggered, in case of SL-M & SL-L

validity'DAY' | 'IOC'
Enum ValuesDescription
DAYValid till end of day
IOCImmediate or Cancel

Response

Successful operation

orderIdstring

Order specific identification generated by Dhan

orderStatus'TRANSIT' | 'PENDING' | 'REJECTED' | 'CANCELLED' | 'PART_TRADED' | 'TRADED' | 'EXPIRED' | 'MODIFIED' | 'TRIGGERED' | 'INACTIVE'
Enum ValuesDescription
TRANSITDid not reach the exchange server
PENDINGReached at exchange end, awaiting execution
REJECTEDRejected at exchange/broker’s end
CANCELLEDCancelled by user
PART_TRADEDPartially Executed
TRADEDExecuted
EXPIREDValidity of order is expired

Changes

No recorded changes to this endpoint across all 1 revision of this API.