Orders

get order by correlation id

The api allows you to retrieve the details of an order placed during the day, with its most recent status, using a correlation id provided by the API consumer at the time of order placement. This feature is available in case the user has missed the order id for any reason.

get/orders/external/{correlation-id}

Path parameters

correlation-idstring required

Headers

access-tokenstring required

Response

Successful operation

dhanClientIdstring

User specific identification generated by Dhan

orderIdstring

Order specific identification generated by Dhan

exchangeOrderIdstring

Order specific identification generated by Exchange

correlationIdstring

The user/partner generated id for tracking back

Enum Values	Description
TRANSIT	Did not reach the exchange server
PENDING	Reached at exchange end, awaiting execution
REJECTED	Rejected at exchange/broker’s end
CANCELLED	Cancelled by user
PART_TRADED	Partially Executed
TRADED	Executed
EXPIRED	Validity of order is expired

transactionType'BUY' | 'SELL'

Signifies the type of transaction whether it's BUY or SELL

exchangeSegment'NSE_EQ' | 'NSE_FNO' | 'BSE_EQ' | 'BSE_FNO' | 'MCX_COMM'

Enums	Exchange	Segment
NSE_EQ	NSE	Equity Cash
NSE_FNO	NSE	Futures & Options
BSE_EQ	BSE	Equity Cash
BSE_FNO	BSE	Futures & Options
MCX_COMM	MCX	Commodity

productType'CNC' | 'INTRADAY' | 'MARGIN' | 'MTF' | 'CO' | 'BO'

Enum Values	Description
CNC	Cash & Carry for equity deliveries
INTRADAY	Intraday for Equity, Futures & Options
MARGIN	Carry Forward in Futures & Options
CO	Cover Order; entry and stop loss
BO	Bracket Order; entry, stop loss & target price
MTF	Margin Traded Fund
CO & BO product types will be valid only for Intraday

orderType'LIMIT' | 'MARKET' | 'STOP_LOSS' | 'STOP_LOSS_MARKET'

Enum Values	Description
LIMIT	For Limit Order types
MARKET	For market Order types
STOP_LOSS	For Stop Loss Limit orders
STOP_LOSS_MARKET	For Stop Loss Market orders

validity'DAY' | 'IOC'

Enum Values	Description
DAY	Valid till end of day
IOC	Immediate or Cancel

tradingSymbolstring

Exchange standard trading symbol

securityIdstring

Exchange standard identification for each scrip

quantityinteger

Number of shares for the order

disclosedQuantityinteger

Number shares visible in the market depth

pricenumber float

Price at which the order is requested to execute

triggerPricenumber float

Price at which the order is triggered

afterMarketOrderboolean

Flag to inform that the order placed is After Market Order

boProfitValuenumber float

Bracket order Target price

boStopLossValuenumber float

Bracket Order/Cover Order Stop Loss Price

legName'ENTRY_LEG' | 'STOP_LOSS_LEG' | 'TARGET_LEG' | 'NA'

Order leg where modification is to be done

createTimestring

Time at which the record is created

updateTimestring

Time at which the record is updated

exchangeTimestring

Time at which order reached at exchange end

drvExpiryDatestring

For F&O, expiry date of contract

drvOptionType'CALL' | 'PUT' | 'NA'

For Options, type CALL or PUT

drvStrikePricenumber float

For Options, Strike Price

omsErrorCodestring

When order is rejected or failed, omsErrorCode would be populated

omsErrorDescriptionstring

When order is rejected or failed, omsErrorDescription would be populated

algoIdstring

Algo_ID

remainingQuantityinteger

Number of shares yet to be traded for the order

averageTradedPricenumber float

Average price at which order is traded

filledQtyinteger

Filled Quantity

Changes

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