---
title: "Run What If Simulation"
method: POST
path: "/api/prd/scenarios/{scenario_id}/what-if"
tags: ["PRD Scenarios"]
---

# Run What If Simulation

`POST /api/prd/scenarios/{scenario_id}/what-if`

## Request

- Base URL: `https://api.getsigvest.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getsigvest.com/api/prd/scenarios/{scenario_id}/what-if`
- Auth: OAuth 2 (password, token URL `api/auth/login`)

POST /api/prd/scenarios/{scenario_id}/what-if
Run What-If simulation for a scenario

## Path parameters

- `scenario_id` string, required

## Request body

- WhatIfSimulationRequest
  - `portfolio_assets` PortfolioAsset[], required
    - `ticker` string, required
    - `quantity` number, required
    - `purchase_price` number, required
    - `current_price` number, nullable
  - `suggested_assets` object[], required
  - `rebalance_percentage` number

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getsigvest/apis/sigvest-api.md) · [All operations](https://skmtc.dev/getsigvest/apis/sigvest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getsigvest/apis/sigvest-api/revisions/3c011b033f7a?raw)