Get the assessable capital gain for a simulated sell trade

POST

/v1/portfolios/{portfolioId}/simulate-sell

Calculates the assessable capital gain if a holding were sold
at the specified price and quantity. Useful for previewing tax impact before
placing a sell order.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Body Params application/json-patch+json

Example

{
    "symbol": "string",
    "exchange": "string",
    "quantity": 0,
    "salePrice": 0,
    "brokerage": 0,
    "exchangeRate": 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 --request POST '/v1/portfolios//simulate-sell' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--data-raw '{
    "symbol": "string",
    "exchange": "string",
    "quantity": 0,
    "salePrice": 0,
    "brokerage": 0,
    "exchangeRate": 0,
    "calculationDate": "2019-08-24T14:15:22.123Z"
}'

Responses

🟢200

application/json

Success

Body

Example

{
    "holdingId": 0,
    "symbol": "string",
    "exchange": "string",
    "assessableCapitalGain": 0,
    "simulatedSaleValue": 0,
    "exchangeRate": 0,
    "cgtStrategy": "string",
    "calculationDate": "2019-08-24T14:15:22.123Z"
}

🟠400

🟠403

🟠404

Modified at 2026-04-07 00:52:05

Update a Price

Pet