DHdhan
Positions & Portfolio

get current positions

Changed on

Users can retrieve a list of all open positions for the day. This includes all F&O carryforward positions as well.

get/positions

Request

  • Base URL
    https://api.dhan.co/v2
  • URL
    https://api.dhan.co/v2/positions
  • Auth
    none declared. Required headers: access-token

Headers

access-tokenstring required

Response

Successful operation

dhanClientIdstring

User specific identification generated by Dhan

tradingSymbolstring

Exchange standard trading symbol

securityIdstring

Exchange standard identification for each scrip

positionType'LONG' | 'SHORT' | 'CLOSED'
Enum ValuesDescription
LONGWhen net bought quantity is more than sold quantity
SHORTWhen net sold quantity is more than bought quantity
CLOSEDWhen no open position standing
exchangeSegment'NSE_EQ' | 'NSE_FNO' | 'BSE_EQ' | 'BSE_FNO' | 'MCX_COMM'
EnumsExchangeSegment
NSE_EQNSEEquity Cash
NSE_FNONSEFutures & Options
BSE_EQBSEEquity Cash
BSE_FNOBSEFutures & Options
MCX_COMMMCXCommodity
productType'CNC' | 'INTRADAY' | 'MARGIN' | 'MTF' | 'CO' | 'BO'
Enum ValuesDescription
CNCCash & Carry for equity deliveries
INTRADAYIntraday for Equity, Futures & Options
MARGINCarry Forward in Futures & Options
COCover Order; entry and stop loss
BOBracket Order; entry, stop loss & target price
MTFMargin Traded Fund
CO & BO product types will be valid only for Intraday
buyAvgnumber float

Average buy price

costPricenumber float

Cost price

buyQtyinteger

Total quantity bought

sellAvgnumber float

Average sell price

sellQtyinteger

Total quantities sold

netQtyinteger

buyQty minus sellQty equals netQty

realizedProfitnumber float

Profit or loss booked

unrealizedProfitnumber float

Profit or loss standing for open position

rbiReferenceRatenumber float

RBI mandated reference rate for forex

multiplierinteger

Multiplying factor for currency F&O

carryForwardBuyQtyinteger

Carry forward F&O long quantities

carryForwardSellQtyinteger

Carry forward F&O short quantities

carryForwardBuyValuenumber float

Carry forward F&O long value

carryForwardSellValuenumber float

Carry forward F&O short value

dayBuyQtyinteger

Quantities bought today

daySellQtyinteger

Quantities sold today

dayBuyValuenumber float

Value of quantities bought today

daySellValuenumber float

Value of quantities sold today

drvExpiryDatestring

For F&O, expiry date of contract

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

For Options, type CALL or PUT

drvStrikePricenumber float

For Options, Strike Price

crossCurrencyboolean

Changes