Portfolio hedge candidates

Return bounded benchmark-instrument factor hedge candidates for a portfolio with compact residual exposure and trust metadata.

post/v1/portfolio/hedge

Request

  • Base URL: https://api.turos.app
  • URL: https://api.turos.app/v1/portfolio/hedge
  • 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[]
objective'factor_neutral' | 'min_drawdown' | 'regime_aware'
mode'compact' | 'standard'

Response

Successful response

dataAsOfstring
freshnessStatus'fresh' | 'stale' | 'degraded' | 'unknown'
methodologyVersionstring
materializationVersionstring
object'portfolio_hedge' 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
analysisIdstring nullable required
asOfstring date-time required
countrystring required
lookbackstring required
objective'factor_neutral' | 'min_drawdown' | 'regime_aware' required
mode'compact' | 'standard' required
residualExposureobject required
optimizationNotesstring[] required
factorNeutralPlanstring[] required
disclosuresstring[]

Short product/legal disclosures for research-scenario outputs.

summaryMdstring required
requestIdstring
traceparentstring

Changes

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