Get return contribution by holding

What each holding contributed to the portfolio's return over a period, so the holdings that drove the return can be ranked. chartDataPoints gives one row per group with the return split into capital gain, income and currency gain; groupedHoldingReturns gives the same for every holding, each carrying the group it fell into; portfolioReturn is the portfolio total the parts sum to. Values are amounts of return in the portfolio's base currency, not weights and not percentages of the portfolio. A large negative contribution is a holding that lost money, not one that was sold. Cash holdings are excluded by the calculation. 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 Contributions Report

Available on: Standard, Premium and Pro

Free trial: not available

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params

application/json-patch+json

Example

{
    "from": "2019-08-24T14:15:22.123Z",
    "to": "2019-08-24T14:15:22.123Z",
    "groupBy": "string",
    "combineHoldings": true,
    "includeClosedPositions": true,
    "filters": [
        {
            "type": "string",
            "value": null,
            "operator": "string",
            "logicalOperator": "string"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "chartDataPoints": [
        {
            "label": "string",
            "value": 0,
            "totalReturnValue": 0,
            "capitalGainValue": 0,
            "incomeReturnValue": 0,
            "currencyGainValue": 0
        }
    ],
    "groupedHoldingReturns": [
        {
            "holdingId": 0,
            "symbol": "string",
            "exchange": "string",
            "displayExchange": "string",
            "holdingTypeId": 0,
            "groupName": "string",
            "holdingReturn": {
                "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,
                "rawCostBase": 0,
                "isAnnualized": true,
                "holdingId": 0,
                "symbol": "string",
                "exchange": "string",
                "currencyCode": "string",
                "quote": {
                    "symbol": "string",
                    "exchange": "string",
                    "name": "string",
                    "tradeDate": "2019-08-24T14:15:22.123Z",
                    "lastTradePrice": 0,
                    "openingPrice": 0,
                    "change": 0,
                    "percentChange": 0,
                    "previousClose": 0,
                    "highPrice": 0,
                    "lowPrice": 0,
                    "volume": 0,
                    "askPrice": 0,
                    "askVolume": 0,
                    "bidPrice": 0,
                    "bidVolume": 0,
                    "tradeCount": 0,
                    "currencyCode": "string",
                    "queryExchange": "string"
                },
                "avgBuyPrice": 0
            }
        }
    ],
    "portfolioReturn": {
        "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,
        "rawCostBase": 0,
        "isAnnualized": true
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠429