Skip to main content

HOLDINGS

This API retrieves the complete list of holdings for a user from the portfolio section, including free quantities, T+1 quantities, valuation, and collateral details.

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"200"
messagestringSuccess message"Holdings fetched successfully"
dataarrayList of holdings grouped by ISINRefer Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
isinstringISIN of the security"INE123A01016"
security_infoarrayList of holdings per exchange/scripRefer Security Info Fields

📘 Security Info Fields

FieldTypeDescriptionExample / Enum
exchangestringExchange segment"NSE_EQ"
scrip_tokenintegerScrip token12345
symbolstringTrading symbol"INFY"
total_freeintegerTotal free quantity (DP + Pool + SAR)100
dp_freeintegerFree quantity in DP60
pool_freeintegerFree quantity in pool30
t1_quantityintegerT+1 holding quantity10
average_pricestringAverage purchase price"1500.50"
last_pricestringCurrent market price"1550.25"
pnlstringProfit/Loss"4975"
current_valuestringCurrent market value"155025"
inv_valuestringInvested value"150050"
productstringProduct type"CNC"
collateral_quantitystringQuantity pledged as collateral"20"
collateral_valuestringCollateral value"31000"