Skip to main content
POST
cURL

Authorizations

X-Api-Key
string
header
required

Path Parameters

organization_uuid
string<uuid>
required

Body

client_account_uuid
string<uuid>
required
scenarios
object[]
required
include_baseline
boolean
default:true
transition
boolean
default:false

Show each scenario as a move into the account's model: held funds the model accepts are kept, the per-fund cap does not force sales, and tax_gain_target_fraction is a share of the gains on holdings the model does not include.

proposed_account_config
object | null

Unsaved account rules, restrictions, and target model, in the account update shape. Every scenario runs as if they were applied; the baseline runs on the saved account. Nothing is saved. Accepted keys: dynamic_rules, no_hold_tickers, no_trade_tickers, portfolio_config_uuid, restriction_exemptions, target_ticker_weights.

Response

202 - application/json
id
string<uuid>
required
read-only
account
object
required

An account or client as a saved analysis names it: its id and what its name is read from.

client
object | null
required

An account or client as a saved analysis names it: its id and what its name is read from.

status
enum<string>
required
  • PENDING - PENDING
  • RUNNING - RUNNING
  • SUCCESS - SUCCESS
  • FAILURE - FAILURE
Available options:
PENDING,
RUNNING,
SUCCESS,
FAILURE
params
any
required
result
object | null
required
error_message
string | null
required
read-only
created_at
string<date-time>
required
read-only
started_at
string<date-time> | null
required
read-only
finished_at
string<date-time> | null
required
read-only