Get Portfolio Holdings API
The Get Portfolio Holdings API allows you to retrieve all stock holdings within a specific portfolio. You can optionally filter by ticker symbol to find specific securities within that portfolio. This endpoint provides comprehensive information about your equity positions including purchase price and quantity held.
Endpoint
GET /user/holdings/{portfolioId}Authentication
All requests require the IdToken obtained from the authentication flow:
Authorization: Bearer <ID_TOKEN>
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| portfolioId | string | Yes | The portfolio ID to retrieve holdings from (e.g., "default") |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| ticker | string | No | Filter holdings by specific ticker symbol (e.g., "AAPL", "MSFT") |
Request Format
Request Body: No request body is required for this endpoint.
Response Format
| Field | Type | Description |
|---|---|---|
| results | array | Array of holding objects in the specified portfolio |
| ticker | string | Stock ticker symbol (e.g., "AAPL", "MSFT") |
| quantity | number | Total quantity of shares held in this portfolio |
| averagePurchasePrice | number | Average cost basis per share (weighted average of all purchases) |
| holdingQuantity | number | Actual holding quantity (may differ from quantity in some cases) |
| portfolioId | string | Portfolio identifier |