Get all portfolios, grouped

Gets every portfolio the current user can reach, in four groups: portfolios
they own, portfolios shared with them, portfolio groups, and game portfolios.
A portfolio group ID is not a portfolio ID and cannot be used on the other
portfolio endpoints.

Access

OAuth scope: portfolios:read

Available on: every plan, including free trials

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "portfolios": [
        {
            "id": 123,
            "name": "Warrens Trust Fund",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "baseCurrencyCode": "AUD",
            "settings": {
                "benchmarkSettings": {
                    "type": "string",
                    "symbol": "XJO",
                    "exchange": "ASX",
                    "displayName": "string",
                    "portfolioId": 0
                },
                "taxEntityType": "individual",
                "calculationSettings": {
                    "includeClosedPositions": true,
                    "annualiseReturns": true,
                    "useSimpleCalculation": true,
                    "includeCashPositions": true
                },
                "endOfFinancialYear": "2019-08-24T14:15:22.123Z",
                "automationSettings": {
                    "enableCorporateActionAutomation": true,
                    "enableDividendAutomation": true
                }
            },
            "isPortfolioGroup": true,
            "isPortfolioOwner": true
        }
    ],
    "sharedPortfolios": [
        {
            "id": 123,
            "name": "Warrens Trust Fund",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "baseCurrencyCode": "AUD",
            "settings": {
                "benchmarkSettings": {
                    "type": "string",
                    "symbol": "XJO",
                    "exchange": "ASX",
                    "displayName": "string",
                    "portfolioId": 0
                },
                "taxEntityType": "individual",
                "calculationSettings": {
                    "includeClosedPositions": true,
                    "annualiseReturns": true,
                    "useSimpleCalculation": true,
                    "includeCashPositions": true
                },
                "endOfFinancialYear": "2019-08-24T14:15:22.123Z",
                "automationSettings": {
                    "enableCorporateActionAutomation": true,
                    "enableDividendAutomation": true
                }
            },
            "isPortfolioGroup": true,
            "isPortfolioOwner": true
        }
    ],
    "portfolioGroups": [
        {
            "id": 123,
            "name": "Warrens Trust Fund",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "baseCurrencyCode": "AUD",
            "settings": {
                "benchmarkSettings": {
                    "type": "string",
                    "symbol": "XJO",
                    "exchange": "ASX",
                    "displayName": "string",
                    "portfolioId": 0
                },
                "taxEntityType": "individual",
                "calculationSettings": {
                    "includeClosedPositions": true,
                    "annualiseReturns": true,
                    "useSimpleCalculation": true,
                    "includeCashPositions": true
                },
                "endOfFinancialYear": "2019-08-24T14:15:22.123Z",
                "automationSettings": {
                    "enableCorporateActionAutomation": true,
                    "enableDividendAutomation": true
                }
            },
            "isPortfolioGroup": true,
            "isPortfolioOwner": true
        }
    ],
    "gamePortfolios": [
        {
            "id": 123,
            "name": "Warrens Trust Fund",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "baseCurrencyCode": "AUD",
            "settings": {
                "benchmarkSettings": {
                    "type": "string",
                    "symbol": "XJO",
                    "exchange": "ASX",
                    "displayName": "string",
                    "portfolioId": 0
                },
                "taxEntityType": "individual",
                "calculationSettings": {
                    "includeClosedPositions": true,
                    "annualiseReturns": true,
                    "useSimpleCalculation": true,
                    "includeCashPositions": true
                },
                "endOfFinancialYear": "2019-08-24T14:15:22.123Z",
                "automationSettings": {
                    "enableCorporateActionAutomation": true,
                    "enableDividendAutomation": true
                }
            },
            "isPortfolioGroup": true,
            "isPortfolioOwner": true
        }
    ]
}

🟠429

Get all portfolios, grouped

Request

Request Code Samples

Responses