Skip to main content
Core Platform

Run a deterministic governed portfolio stress scenario

POST /investment/portfolios/{portfolio}/scenarios

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 · optional
{
    "global_price_pct": -100,
    "symbols": [],
    "factors": []
}

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 '{
    "global_price_pct": -100,
    "symbols": [],
    "factors": []
}' \
  "https://financegpt.dev/api/v2/investment/portfolios/{portfolio}/scenarios"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/investment\/portfolios\/{portfolio}\/scenarios", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "global_price_pct": -100,
    "symbols": [],
    "factors": []
}),
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/investment/portfolios/{portfolio}/scenarios',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
    json=json.loads('{"global_price_pct":-100,"symbols":[],"factors":[]}'),
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/investment/portfolios/{portfolio}/scenarios');
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 (
  'global_price_pct' => -100,
  'symbols' => 
  array (
  ),
  'factors' => 
  array (
  ),
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
201 Scenario run with source and result hashes

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

Machine-readable sources