Compute the trades that, applied to the portfolio, would move it toward the active (or specified) allocation model under the given user-supplied constraints. Pure deterministic math — not financial advice.

POST

/v1/portfolios/{portfolioId}/calculate-rebalance

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Body Params

application/json-patch+json

Example

{
    "modelPublicId": "string",
    "availableCash": 0,
    "maxCgtBudget": 0,
    "preferLossHarvesting": true,
    "preferDiscountEligibleParcels": true,
    "excludeHoldingIds": [
        0
    ],
    "minTradeValue": 0,
    "brokeragePerTrade": 0,
    "calculationDate": "2019-08-24T14:15:22.123Z"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/portfolios//calculate-rebalance' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--data '{
    "modelPublicId": "string",
    "availableCash": 0,
    "maxCgtBudget": 0,
    "preferLossHarvesting": true,
    "preferDiscountEligibleParcels": true,
    "excludeHoldingIds": [
        0
    ],
    "minTradeValue": 0,
    "brokeragePerTrade": 0,
    "calculationDate": "2019-08-24T14:15:22.123Z"
}'

Responses

🟢200

application/json

Success

Bodyapplication/json

Example

{
    "legs": [
        {
            "holdingId": 0,
            "symbol": "string",
            "exchange": "string",
            "tradeTypeId": 0,
            "tradeDate": "2019-08-24T14:15:22.123Z",
            "quantity": 0,
            "price": 0,
            "brokerage": 0,
            "currencyCode": "string"
        }
    ],
    "warnings": [
        "string"
    ],
    "driftBefore": {
        "dimension": "string",
        "modelName": "string",
        "modelPublicId": "string",
        "entries": [
            {
                "bucketLabel": "string",
                "currentPct": 0,
                "targetPct": 0,
                "afterPct": 0,
                "tolerancePct": 0,
                "currentValue": 0,
                "afterValue": 0,
                "status": "string"
            }
        ]
    }
}

Modified at 2026-05-17 10:02:35

Mark a model active (clears the active flag on all others for the portfolio).

Pet