Get portfolio return broken down by group

The portfolio's return over a period, with returnsByType holding the same figures again for each group of the chosen dimension, so groups can be ranked against each other and against the portfolio. Use it to answer which sector, exchange, currency or source performed best. The top level object is the whole portfolio; each entry in returnsByType is one group. Percentages are period returns on that group's own cost base, so a small group can post a large percentage on very little money: read totalReturnValue beside totalReturnPercent before calling a group the best. isAnnualized says whether the percentages have been annualised. Cash holdings are included, unlike the Category report in the Navexa web app, so a Cash group can appear. groupBy accepts none, holding, displayExchange, currencyCode, industry, sector, source, portfolio, holdingType, or the name of a custom group on the portfolio, matched exactly; any other value is refused with 400.

Access

OAuth scope: performance:read

Plan feature: Portfolio Tracking

Available on: Basic, Standard, Premium and Pro

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "calculationDate": "2019-08-24T14:15:22.123Z",
    "totalValue": 0,
    "totalReturnValue": 0,
    "totalReturnPercent": 0,
    "realisedReturnValue": 0,
    "realisedReturnPercent": 0,
    "unrealisedReturnValue": 0,
    "unrealisedReturnPercent": 0,
    "capitalGainValue": 0,
    "capitalGainPercent": 0,
    "dividendReturnValue": 0,
    "dividendReturnPercent": 0,
    "currencyGainValue": 0,
    "currencyGainPercent": 0,
    "costBase": 0,
    "isAnnualized": true,
    "returnsByType": {
        "property1": {},
        "property2": {}
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠429