Run portfolio stress test

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

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

Query parameters

response_mode'compact' | 'standard' | 'verbose'

Response projection. compact is token-efficient for agents; standard returns the full operational shape; verbose preserves full trust metadata and drill-down context.

includestring

Comma-separated compact-mode expansions such as trust, metadata, series, diagnostics, exposures, position_views, position_exposures, optimizer_candidates, or drilldown. Use trust when an agent or report needs provenance, freshness, source-rights, methodology, revision, and degraded-state metadata; use diagnostics for regression details such as rSquared and tStat where supported.

Request body

countrystring
lookbackstring
categorystring
keysstring[]
scenarioKeystring
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'

Response

Successful response

dataAsOfstring
freshnessStatus'fresh' | 'stale' | 'degraded' | 'unknown'
methodologyVersionstring
materializationVersionstring
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.

idstring required
asOfstring date-time required
scenarioKeystring required
scenarioLabelstring required
scenarioSource'catalog' | 'ad_hoc'
estimatedDrawdownPercentnumber required
factorShocksobject required
macroShocksobject required
regimeobject nullable
conditioningNotesstring[] required
summaryMdstring required
disclosuresstring[]

Short product/legal disclosures for research-scenario outputs. Omitted on low-risk compact responses.

requestIdstring
traceparentstring

Changes

No recorded changes to this operation across all 1 revision of this API.