Get Portfolio by ID API
The Get Portfolio by ID API allows you to retrieve detailed information about a specific portfolio by its ID. Use this endpoint when you need information about a single portfolio rather than all portfolios.
Endpoint
GET /user/portfolios/{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 unique portfolio identifier (e.g., "default") |
Request Format
Request Body: No request body is required for this endpoint.
Response Format
| Field | Type | Description |
|---|---|---|
| portfolioId | string | Unique portfolio identifier |
| name | string | Portfolio display name |
| description | string | Portfolio description or investment strategy summary |
| availableAmount | number | Cash available for trading in the portfolio |
| currentValue | number | Current total value of portfolio holdings and cash (optional) |
| type | string | Market type (`STOCKS`, `OPTIONS`, `FUTURES`) |
| ytdReturn | number | Year-to-date return percentage |
| oneYearReturn | number | One-year return percentage |
| visibility | string | Portfolio visibility: "PRIVATE" or "PUBLIC" |
| risktd | number | Risk metric for today (optional) |
| risk3m | number | Risk metric for 3 months (optional) |
| risk6m | number | Risk metric for 6 months (optional) |
| risk1y | number | Risk metric for 1 year (optional) |
| riskC | number | Cumulative risk metric (optional) |
| copiers | number | Number of users copying this portfolio |
| b | string | Internal identifier (optional) |
| live | number | Live status indicator: 1 = active, 0 = inactive (optional) |
| pType | string | Portfolio type: "Stocks&ETFs", etc. (optional) |
| hashtags | array | Tags associated with the portfolio (optional) |