Create a portfolio

POST

/v1/portfolios

Creates a new portfolio for the current user.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Body Params application/json-patch+json

Example

{
    "name": "My Portfolio",
    "baseCurrencyCode": "AUD",
    "settings": {
        "taxEntityType": "individual",
        "endOfFinancialYear": "06-30",
        "enableCorporateActionAutomation": true,
        "enableDividendAutomation": true
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/portfolios' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--data-raw '{
    "name": "My Portfolio",
    "baseCurrencyCode": "AUD",
    "settings": {
        "taxEntityType": "individual",
        "endOfFinancialYear": "06-30",
        "enableCorporateActionAutomation": true,
        "enableDividendAutomation": true
    }
}'

Responses

🟢200OK

Success

This response does not have a body.

Modified at 2025-10-24 04:35:20

Get all portfolios

Get a portfolio