---
title: "Get all performance details for the given portfolio, best presented in table format"
method: POST
path: "/portfolio_details"
---

# Get all performance details for the given portfolio, best presented in table format

`POST /portfolio_details`

## Request

- Base URL: `https://portfoliopilot.com/api/gpt`
- URL: `https://portfoliopilot.com/api/gpt/portfolio_details`
- Auth: none declared
- TypeScript: <https://skmtc.dev/portfoliopilot/apis/portfoliopilot-plugin/docs/portfolio_details/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- object
  - `portfolio` Investment[]: Provided portfolio for the user. Use ticker CUR:USD for cash, ticker Reserved.RealEstate for real estate, ticker Reserved.Crypto for cryptocurrencies, ticker Private.MoneyMarket for money market funds
    - `T` string, required: ticker symbol
    - `A` number, required: amount representing current market value

## Response `200`

OK

- GetPortfolioDetailsResponse
  - `portfolio_details` PortfolioDetails[]: Performance details and assumptions for each security in the given portfolio
    - `ticker` string
    - `weight` number: The proportion of the security within the investment portfolio
    - `market_beta` number: The systemic risk of the security compared to the market as a whole
  - `total_amount` number: The total amount invested in the portfolio
  - `dividend_return_in_dollars` number
  - `details_url` string: url to the PortfolioPilot Portfolio Details page providing more information (create link)

## Other responses

- `400`: Bad Request
- `405`: Method not allowed (e.g. GET request type is not supported, use POST method instead)

## Changes

- **2025-01-28** `e2d1ba050ae9`: 3 breaking, 3 warning, 2 info
  - the `portfolio_details/items/market_beta` response's property format changed from `float` to no format for status `200`
  - the `portfolio_details/items/weight` response's property format changed from `float` to no format for status `200`
  - the `total_amount` response's property format changed from `float` to no format for status `200`
  - removed the optional property `portfolio_details/items/expected_return` from the response with the `200` status
  - …4 more

[Operation history](https://skmtc.dev/portfoliopilot/apis/portfoliopilot-plugin/changes/portfolio_details/post.md)

---

[API](https://skmtc.dev/portfoliopilot/apis/portfoliopilot-plugin.md) - [All operations](https://skmtc.dev/portfoliopilot/apis/portfoliopilot-plugin/llms.txt) - [OpenAPI document](https://skmtc.dev/portfoliopilot/apis/portfoliopilot-plugin/revisions/7ed0083c9099?raw)