---
title: "Get Scenario"
method: GET
path: "/api/forced-flow/scenario"
tags: ["Forced Flow"]
---

# Get Scenario

`GET /api/forced-flow/scenario`

## Request

- Base URL: `https://api.zerogex.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.zerogex.io/api/forced-flow/scenario`
- Auth: HTTP bearer

One arbitrary what-if: (spot move, time, vol shift) -> flow + attribution.

## Query parameters

- `symbol` string
- `expiry` string, nullable
- `spot_move_pct` number: Spot move, fraction
- `days` number: Calendar days elapsed
- `vol_change_pts` number

## Response `200`

Successful Response

- ScenarioResponse
  - `symbol` string, required
  - `spot` number, required
  - `timestamp` string, date-time, required
  - `spot_move_pct` number, required
  - `days` number, required
  - `vol_change_pts` number, required
  - `total_usd` number, required
  - `gamma_component` number, required
  - `charm_component` number, required
  - `vanna_component` number, required
  - `residual` number, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/zerogex/apis/zerogex-api.md) · [All operations](https://skmtc.dev/zerogex/apis/zerogex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zerogex/apis/zerogex-api/revisions/753b26bf0592?raw)
