---
title: "Run portfolio stress test"
method: POST
path: "/v1/portfolio/stress-test"
---

# Run portfolio stress test

`POST /v1/portfolio/stress-test`

## Request

- Base URL: `https://api.turos.app`
- URL: `https://api.turos.app/v1/portfolio/stress-test`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Run portfolio stress scenarios across factor and macro shock definitions with compact traceable outputs.

## Query parameters

- `response_mode` 'compact' | 'standard' | 'verbose'
- `include` string

## Request body

- PortfolioStressTestRequest
  - `country` string
  - `lookback` string
  - `category` string
  - `keys` string[]
  - `scenarioKey` string
  - `namedScenarioKey` 'gfc_2008' | 'covid_2020' | 'rate_shock_2022' | 'taper_tantrum_2013' | 'oil_shock_2014' | 'oil_shock_2022': Named historical scenario (GFC 2008, COVID 2020, 2022 rate shock, 2013 taper, oil shocks).
  - `benchmark` 'SPY' | 'ACWX' | 'QQQ' | 'IWM' | 'SIXTY_FORTY'
  - `customScenario` object
    - `label` string, required
    - `factorShocks` object
    - `macroShocks` object
  - `holdings` PortfolioHoldingInput[], required
    - `symbol` string, required
    - `weight` number, required
    - `shares` number, nullable
    - `costBasis` number, nullable

## Response `200`

Successful response

- PortfolioStressTest
  - `dataAsOf` string
  - `freshnessStatus` 'fresh' | 'stale' | 'degraded' | 'unknown'
  - `methodologyVersion` string
  - `materializationVersion` string
  - `object` 'portfolio_stress_test', required
  - `responseMode` 'compact' | 'standard' | 'verbose': Projection used for this resource. compact is token-efficient for agents; standard and verbose retain fuller operational context.
  - `id` string, required
  - `asOf` string, date-time, required
  - `scenarioKey` string, required
  - `scenarioLabel` string, required
  - `scenarioSource` 'catalog' | 'ad_hoc'
  - `estimatedDrawdownPercent` number, required
  - `factorShocks` object, required
  - `macroShocks` object, required
  - `contributions` object[]
    - `factorKey` string, required
    - `beta` number, required
    - `shock` number, required
    - `contribution` number, required
    - `direction` 'headwind' | 'tailwind' | 'neutral', required
    - `rationale` string, required
    - `sensitivitySource` string, required
  - `regime` object, nullable
  - `conditioningNotes` string[], required
  - `summaryMd` string, required
  - `disclosures` string[]: Short product/legal disclosures for research-scenario outputs. Omitted on low-risk compact responses.
  - `provenance` ResponseMetadata
    - `source` string, required
    - `sourceLabel` string
    - `sourceAgency` string
    - `canonicality` string
    - `fallbackPolicy` string
    - `accessionNumber` string, nullable, required
    - `filingUrl` string, uri, required
    - `acceptedAt` string, nullable
    - `retrievedAt` string, required
    - `parserVersion` string, required
  - `freshness` FreshnessMetadata: Freshness of the record. For SEC filings, freshness measures the delay between SEC acceptance (`sourcePublishedAt`) and when the record became available in the API — not the age of the document. Statuses: `current` (recently published and available promptly), `archival` (an immutable historical document held in full; its availability delay is not a freshness signal), `degraded`/`stale` (a recently published filing that became available later than the freshness thresholds allow), `fresh` (continuously refreshed datasets recently observed at source), `unknown` (no timestamps). An old immutable filing is never `stale` simply because it was published long ago. `lagMs` is the publish-to-availability delay in milliseconds.
    - `status` 'fresh' | 'current' | 'archival' | 'stale' | 'degraded' | 'unknown', required
    - `asOf` string, required
    - `sourcePublishedAt` string, nullable
    - `lagMs` integer, nullable
  - `materialization` MaterializationMetadata
    - `parserVersion` string, required
    - `materializationVersion` string, required
  - `sourceRights` SourceRightsMetadata
    - `source` string, required
    - `sourceLabel` string
    - `posture` 'public_safe' | 'contract_gated' | 'internal_only' | 'inventory_only' | 'review_required', required
    - `publicAvailability` 'public' | 'contract_gated' | 'internal_only' | 'inventory_only', required
    - `contractStatus` 'approved' | 'review_required' | 'restricted' | 'prohibited' | 'expired', required
    - `restrictions` string[]
    - `notes` string, nullable
  - `methodology` MethodologyMetadata
    - `id` string, required
    - `version` string, required
    - `summary` string, required
    - `confidence` 'high' | 'medium' | 'low', required
    - `launchState` 'experimental' | 'beta' | 'ga', required
    - `inputs` string[]
    - `validation` object
  - `revision` RevisionMetadata
    - `sourcePublishedAt` string, nullable
    - `retrievedAt` string, required
    - `vintageId` string, nullable
    - `revisedFrom` string, nullable
  - `degradedState` DegradedState
    - `code` string, required
    - `message` string, required
    - `retryable` boolean, required
    - `missingCapabilities` string[]
    - `fallbackUsed` string[]
  - `requestId` string
  - `traceparent` string

## Other responses

- `default`: Contract-aware error response

---

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