Get portfolio performance

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

or

Path Params

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/v1/portfolios//performance?from&to&isPortfolioGroup&groupBy&showLocalCurrency' \
--header 'Authorization: <api-key>'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "portfolioId": 0,
    "portfolioName": "string",
    "baseCurrencyCode": "string",
    "holdings": [
        {
            "id": 0,
            "portfolioId": 0,
            "symbol": "string",
            "name": "string",
            "holdingTypeId": 0,
            "portfolioName": "string",
            "displayExchange": "string",
            "exchange": "string",
            "quantity": 0,
            "currentPrice": 0,
            "percentChange": 0,
            "totalReturn": {
                "calculationDate": "2019-08-24T14:15:22Z",
                "totalValue": 0,
                "totalReturnValue": 0,
                "totalReturnPercent": 0,
                "capitalGainValue": 0,
                "capitalGainPercent": 0,
                "dividendReturnValue": 0,
                "dividendReturnPercent": 0,
                "currencyGainValue": 0,
                "currencyGainPercent": 0,
                "isAnnualized": true,
                "returnsByType": {
                    "property1": {
                        "calculationDate": "2019-08-24T14:15:22Z",
                        "totalValue": 0,
                        "totalReturnValue": 0,
                        "totalReturnPercent": 0,
                        "capitalGainValue": 0,
                        "capitalGainPercent": 0,
                        "dividendReturnValue": 0,
                        "dividendReturnPercent": 0,
                        "currencyGainValue": 0,
                        "currencyGainPercent": 0,
                        "isAnnualized": true,
                        "returnsByType": {
                            "property1": {},
                            "property2": {}
                        }
                    },
                    "property2": {
                        "calculationDate": "2019-08-24T14:15:22Z",
                        "totalValue": 0,
                        "totalReturnValue": 0,
                        "totalReturnPercent": 0,
                        "capitalGainValue": 0,
                        "capitalGainPercent": 0,
                        "dividendReturnValue": 0,
                        "dividendReturnPercent": 0,
                        "currencyGainValue": 0,
                        "currencyGainPercent": 0,
                        "isAnnualized": true,
                        "returnsByType": {
                            "property1": {},
                            "property2": {}
                        }
                    }
                }
            },
            "currencyCode": "string",
            "groupedByValue": "string",
            "isEmpty": true,
            "totalQuantity": 0,
            "holdingWeight": 0,
            "excludedFromCalculations": true,
            "isValid": true
        }
    ],
    "totalValue": 0,
    "totalReturn": {
        "calculationDate": "2019-08-24T14:15:22Z",
        "totalValue": 0,
        "totalReturnValue": 0,
        "totalReturnPercent": 0,
        "capitalGainValue": 0,
        "capitalGainPercent": 0,
        "dividendReturnValue": 0,
        "dividendReturnPercent": 0,
        "currencyGainValue": 0,
        "currencyGainPercent": 0,
        "isAnnualized": true,
        "returnsByType": {
            "property1": {},
            "property2": {}
        }
    },
    "generatedDate": "2019-08-24T14:15:22Z",
    "dateRange": {
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z"
    },
    "accountLinks": [
        {
            "providerName": "string",
            "logoUrl": "string",
            "status": "string",
            "lastSynced": "2019-08-24T14:15:22Z"
        }
    ],
    "hasHoldings": true
}