---
title: "Portfolio hedge candidates"
method: POST
path: "/v1/portfolio/hedge"
---

# Portfolio hedge candidates

`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

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

## Query parameters

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

## Request body

- PortfolioHedgeRequest
  - `country` string
  - `lookback` string
  - `category` string
  - `keys` string[]
  - `objective` 'factor_neutral' | 'min_drawdown' | 'regime_aware'
  - `mode` 'compact' | 'standard'
  - `constraints` PortfolioHedgeConstraints
    - `maxHedges` integer
    - `maxPositionWeight` number
    - `maxTotalHedgeWeight` number
    - `maxSectorWeight` number
    - `hedgeIntensity` number
    - `longOnly` boolean
    - `allowedInstrumentTypes` PortfolioHedgeInstrumentType[]
    - `customUniverse` string[]
    - `targetExposures` object
    - `minConfidence` 'low' | 'medium' | 'high'
    - `minLiquidityUsd` number
    - `excludedSectors` string[]
  - `holdings` PortfolioHoldingInput[], required
    - `symbol` string, required
    - `weight` number, required
    - `shares` number, nullable
    - `costBasis` number, nullable

## Response `200`

Successful response

- PortfolioHedge
  - `dataAsOf` string
  - `freshnessStatus` 'fresh' | 'stale' | 'degraded' | 'unknown'
  - `methodologyVersion` string
  - `materializationVersion` string
  - `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.
  - `id` string, required
  - `analysisId` string, nullable, required
  - `asOf` string, date-time, required
  - `country` string, required
  - `lookback` string, required
  - `objective` 'factor_neutral' | 'min_drawdown' | 'regime_aware', required
  - `mode` 'compact' | 'standard', required
  - `constraints` PortfolioHedgeConstraints, required
    - `maxHedges` integer
    - `maxPositionWeight` number
    - `maxTotalHedgeWeight` number
    - `maxSectorWeight` number
    - `hedgeIntensity` number
    - `longOnly` boolean
    - `allowedInstrumentTypes` PortfolioHedgeInstrumentType[]
    - `customUniverse` string[]
    - `targetExposures` object
    - `minConfidence` 'low' | 'medium' | 'high'
    - `minLiquidityUsd` number
    - `excludedSectors` string[]
  - `holdings` PortfolioHoldingInput[], required
    - `symbol` string, required
    - `weight` number, required
    - `shares` number, nullable
    - `costBasis` number, nullable
  - `targetExposures` PortfolioHedgeTargetExposure[], required
    - `object` 'portfolio_hedge_target_exposure', required
    - `factorKey` string, required
    - `factorName` string, required
    - `factorCategory` string, required
    - `beta` number, required
    - `targetExposureDelta` number, required
    - `proposedExposureDelta` number, required
    - `residualBeta` number, required
    - `hedged` boolean, required
    - `skipReason` string, nullable, required
  - `hedges` PortfolioHedgeCandidate[], required
    - `object` 'portfolio_hedge_candidate', required
    - `rank` integer, required
    - `factorKey` string, required
    - `factorName` string, required
    - `factorCategory` string, required
    - `symbol` string, required
    - `instrumentType` 'equity' | 'etf' | 'future' | 'option' | 'cash', required
    - `action` 'long' | 'short', required
    - `recommendedWeight` number, required
    - `targetExposureDelta` number, required
    - `expectedExposureDelta` object, required
    - `residualBeta` number, required
    - `constraintStatus` 'ok' | 'capped', required
    - `constraintsApplied` string[], required
    - `liquidityUsd` number, nullable, required
    - `estimatedCostBps` number, nullable, required
    - `sectorKey` string, nullable, required
    - `rationale` string, required
    - `confidence` 'high' | 'medium' | 'low', required
  - `residualExposure` object, required
  - `exposures` FactorExposure[], required
    - `dataAsOf` string
    - `freshnessStatus` 'fresh' | 'stale' | 'degraded' | 'unknown'
    - `methodologyVersion` string
    - `materializationVersion` string
    - `object` 'factor_exposure', 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
    - `subjectType` 'security' | 'portfolio' | 'watchlist', required
    - `subjectKey` string, required
    - `factorKey` string, required
    - `factorName` string
    - `factorCategory` string
    - `beta` number, required
    - `intercept` number, nullable
    - `rSquared` number, nullable
    - `adjustedRSquared` number, nullable
    - `tStat` number, nullable
    - `observationCount` integer, nullable
    - `nActiveFactors` integer, nullable
    - `percentile` number, nullable
    - `confidence` 'high' | 'medium' | 'low', nullable
    - `modelName` string, nullable
    - `asOf` string, date-time, required
    - `expansionHints` string[]
    - `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[]
  - `optimizationNotes` string[], required
  - `factorNeutralPlan` string[], required
  - `disclosures` string[]: Short product/legal disclosures for research-scenario outputs.
  - `summaryMd` string, required
  - `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)