Get portfolio diversification

POST

/v1/portfolios/{portfolioId}/diversification

Break a portfolio down by a grouping dimension and return the weight of each
holding and each group as a percentage of total value. GroupBy accepts
none, holding, displayExchange, currencyCode, industry, sector, source,
portfolio, holdingType, or the name of a custom group on the portfolio.

Access

OAuth scope: performance:read

Plan feature: Portfolio Diversification Report

Available on: Basic, 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",
    "filters": [
        {
            "type": "string",
            "value": null,
            "operator": "string",
            "logicalOperator": "string"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/portfolios//diversification' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--data '{
    "from": "2019-08-24T14:15:22.123Z",
    "to": "2019-08-24T14:15:22.123Z",
    "groupBy": "string",
    "filters": [
        {
            "type": "string",
            "value": null,
            "operator": "string",
            "logicalOperator": "string"
        }
    ]
}'

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "chartDataPoints": [
        {
            "label": "string",
            "value": 0
        }
    ],
    "weightedHoldings": [
        {
            "holdingId": 0,
            "symbol": "string",
            "exchange": "string",
            "holdingTypeId": 0,
            "groupedBy": "string",
            "totalValue": 0,
            "weighting": 0
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠429

Modified at 2026-09-17 10:19:59

Get return contribution by holding

Get portfolio income calendar