Skip to content
Patrimoine
v9.1.0

Portfolio Summary Endpoint

GET
/api/v1/investments/summary
curl --request GET \
  --url https://example.com/api/v1/investments/summary

Portfolio-wide ROI: unrealized gains, dividends, total return.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PortfolioSummaryOut

Portfolio-wide ROI metrics, base-currency converted, built explicitly by get_portfolio_summary() (no from_attributes – not a direct ORM row). Money fields are base-currency decimal strings; percentages are plain floats rounded to 2 places. total_cost/total_value/ unrealized_gain are pure price-performance sums (cost and value both priced at each holding’s historical FX rate); total_fx_gain is the separate currency-timing sum; total_return is unrealized_gain plus total_dividends. total_cost includes each holding’s fee, and the percentages divide by it.

object
total_cost
required
Total Cost
string
total_value
required
Total Value
string
total_dividends
required
Total Dividends
string
unrealized_gain
required
Unrealized Gain
string
unrealized_gain_pct
required
Unrealized Gain Pct
number
total_fx_gain
required
Total Fx Gain
string
dividend_yield_pct
required
Dividend Yield Pct
number
total_return
required
Total Return
string
total_return_pct
required
Total Return Pct
number
holdings_count
required
Holdings Count
integer

Example generated

{
  "total_cost": "example",
  "total_value": "example",
  "total_dividends": "example",
  "unrealized_gain": "example",
  "unrealized_gain_pct": 1,
  "total_fx_gain": "example",
  "dividend_yield_pct": 1,
  "total_return": "example",
  "total_return_pct": 1,
  "holdings_count": 1
}