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
| Parameter | Type | Required | Description | Example |
|---|
| userId | string | Yes | User ID (UCC) | "{{user_id}}" |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize 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 | "200" |
| message | string | Success message | "Holdings fetched successfully" |
| data | array | List of holdings grouped by ISIN | Refer Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example |
|---|
| isin | string | ISIN of the security | "INE123A01016" |
| security_info | array | List of holdings per exchange/scrip | Refer Security Info Fields |
📘 Security Info Fields
| Field | Type | Description | Example / Enum |
|---|
| exchange | string | Exchange segment | "NSE_EQ" |
| scrip_token | integer | Scrip token | 12345 |
| symbol | string | Trading symbol | "INFY" |
| 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 holding quantity | 10 |
| average_price | string | Average purchase price | "1500.50" |
| last_price | string | Current market price | "1550.25" |
| pnl | string | Profit/Loss | "4975" |
| current_value | string | Current market value | "155025" |
| inv_value | string | Invested value | "150050" |
| product | string | Product type | "CNC" |
| collateral_quantity | string | Quantity pledged as collateral | "20" |
| collateral_value | string | Collateral value | "31000" |