Skip to main content

Holdings

This API fetches the complete list of long-term equity holdings for the authenticated user, grouped by ISIN. It includes the current market value, invested value, P&L, and quantity breakdown across DP, Pool, and T+1 buckets.

🔑Header Parameters

🔑 Header Parameters

HeaderTypeRequiredDescriptionExample
Content-TypestringYesSpecifies the media type of the requestapplication/json
AuthorizationstringYesBearer token for authenticated requests{{access_token}}
x-api-keystringYesAPI key used to authorize the request{{x-api-key}}

🟢Success Response - 200 Ok

FieldTypeDescriptionExample
statusstringIndicates the status of the API Call"success"
codestringResponse code of the API Request"s-101"
messagestringDescriptive message"Holdings fetched Successfully"
dataarray of objectsList of scrips and holding detailsSee data structure below

🧾Data Object Info Fields

Note on security_info: Each holding is identified by ISIN and may be listed on multiple exchanges (e.g., both NSE_EQ and BSE_EQ). The security_info array contains one entry per exchange listing for that ISIN, each with its own exchange segment and scrip token. Use the appropriate entry based on the exchange you intend to trade on.

FieldTypeDescriptionExample
isinstringISIN code of the scripINE002A01018
security_infoarray of objectSecurity information (e.g.,scrip metadata)See Security Info Object Fields below
total_freeintegerTotal free quantity (DP + Poll + SAR)150
dp_freeintegerFree quantity in Demat (DP)100
pool_freeintegerFree quantity in pool30
t1_quantityintegerQuantity available on T+120
average_pricestringAverage purchase price of the scrip"102.45"
last_pricestringLast trader price"110.00"
pnlstringCurrent profit and loss of the holding"-1.10"
current_valuestringCurrent market value of the holding"3300.00"
inv_valuestringTotal invested value"3225.00"
productstringProduct type"DELIVERY"
collateral_quantityintegerQuantity marked as collateral"50"
collateral_valuestringValue of the collateral"5500.00"
close_priceintegerPrevious close price108
dppledge_collateral_qtyintegerQuantity pledged via DP10
poolpledge_collateral_qtyintegerQuantity pledged from Pool20

📑Security Info Object Fields

FieldTypeDescriptionExample
exchangestringExchange segments where the scrip is listed"NSE_EQ"
scrip_tokenstringUnique token/ID assigned to the scrip by the exchange"1333", "500180"
symbolstringTrading symbol of the scrip as per the exchange's scrip master file"HDFCBANK"