HOLDINGS API

This API retrieves the complete list of holdings from the portfolio, including quantity, valuation, and collateral details for each security.

🔍 Query Parameters

Parameter	Type	Required	Description	Example
client_id	string	No	Client ID to fetch holdings for a specific end user	client_id=VISHAL1

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Specifies the media type of the request payload	application/json
Authorization	string	Dealer authentication token	Bearer {{access_token}}
x-api-key	string	API key used to authorize the request	{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

Field	Type	Description	Example
status	string	Status of API call	"success"
code	string	Response code to user request	"s-101"
message	string	Success message	"Holdings fetched successfully"
data	object[]	Array of holding objects	Refer below

📦 Holding Object Fields

Field	Type	Description	Example
isin	string	ISIN of the security	"INE002A01018"
security_info	object[]	Array containing security-level details	Refer below
total_free	integer	Total free quantity (DP + Pool + SAR)	100
dp_free	integer	Free quantity in DP	60
pool_free	integer	Free quantity in pool	30
t1_quantity	integer	T+1 quantity	10
average_price	string	Average purchase price	"2500.50"
last_price	string	Current market price	"2550.00"
pnl	string	Profit or Loss	"4950"
current_value	string	Current market value	"255000"
inv_value	string	Invested value	"250050"
product	string	Product type	"CNC"
collateral_quantity	string	Quantity pledged as collateral	"50"
collateral_value	string	Value of pledged collateral	"125000"

📊 Security Info Object Fields

Field	Type	Description	Example
exchange	string	Exchange segment	"NSE"
scrip_token	integer	Token number of the instrument	12345
symbol	string	Trading symbol	"RELIANCE"