Core Platform
Create a tax-harvest proposal without executing a trade
POST
/investment/portfolios/{portfolio}/tax-harvest
Contract
Authentication
Bearer credential required
Required scope
investment:run
Status
Published
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
portfolio |
path | string | Yes | — |
Request body
application/json
·
required
{
"tax_regime": "string",
"jurisdiction": "string",
"tax_rate_pct": 0,
"minimum_loss_usd": 0,
"restriction_window_days": 0,
"replacement_symbols": [
"string"
]
}
Code examples
These examples compose a request only. Public reference pages never transmit your credential or execute the operation.
curl
curl -X POST \
-H "Authorization: Bearer $FINANCEGPT_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
--data '{
"tax_regime": "string",
"jurisdiction": "string",
"tax_rate_pct": 0,
"minimum_loss_usd": 0,
"restriction_window_days": 0,
"replacement_symbols": [
"string"
]
}' \
"https://financegptlabs.com/api/v2/investment/portfolios/{portfolio}/tax-harvest"
javascript
const response = await fetch("https:\/\/financegptlabs.com\/api\/v2\/investment\/portfolios\/{portfolio}\/tax-harvest", {
method: "POST",
headers: {
Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"tax_regime": "string",
"jurisdiction": "string",
"tax_rate_pct": 0,
"minimum_loss_usd": 0,
"restriction_window_days": 0,
"replacement_symbols": [
"string"
]
}),
});
const data = await response.json();
python
import json
import os
import requests
response = requests.request(
'POST',
'https://financegptlabs.com/api/v2/investment/portfolios/{portfolio}/tax-harvest',
headers={
'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
'Accept': 'application/json',
},
json=json.loads('{"tax_regime":"string","jurisdiction":"string","tax_rate_pct":0,"minimum_loss_usd":0,"restriction_window_days":0,"replacement_symbols":["string"]}'),
)
response.raise_for_status()
print(response.json())
php
<?php
$ch = curl_init('https://financegptlabs.com/api/v2/investment/portfolios/{portfolio}/tax-harvest');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'),
'Accept: application/json',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode(array (
'tax_regime' => 'string',
'jurisdiction' => 'string',
'tax_rate_pct' => 0,
'minimum_loss_usd' => 0,
'restriction_window_days' => 0,
'replacement_symbols' =>
array (
0 => 'string',
),
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Responses
| Status | Description |
|---|---|
201 |
Draft tax-harvest proposal; financial_action_executed is false |
Authority boundary
A developer credential proves application identity and permits only its scopes. It does not grant model promotion, policy override, QLM rebinding, or Financial Actions execution authority unless those separate controls are satisfied.
investment:run