v56

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-215245616.9 KB

Find Hedging Opportunities

get/api/router/fetchHedges

Query parameters

querystring

Keyword search across matched market titles.

categorystring

Filter matches by category.

marketIdstring required

The unique identifier for this market

eventIdstring

Link to parent event

titlestring required

The market title (e.g., "Will BTC close above $100k on Dec 31?").

descriptionstring required

Long-form market description or resolution criteria.

slugstring

URL-friendly slug for the market.

resolutionDatestring date-time

When the market is scheduled to resolve. Optional because some venues do not publish a cutoff for every market (e.g. Opinion categorical children) — emit undefined rather than coercing to epoch.

volume24hnumber required

Trading volume over the past 24 hours (USD).

volumenumber

Total / Lifetime volume

liquiditynumber required

Current market liquidity (USD).

openInterestnumber

Total value of outstanding contracts (USD).

urlstring required

Canonical URL to view the market on the venue.

imagestring

Optional image URL for the market.

categorystring

Optional category label. Venue-defined — common values include "Sports", "Politics", "Crypto", "Economics", "Science", "Culture". Polymarket uses finer-grained categories like "Bitcoin", "Soccer", "Economic Policy"; Kalshi uses broader ones like "Sports" or "Mentions".

tagsstring[]

Optional list of tags. More granular than category — e.g. ["Crypto", "Crypto Prices", "Bitcoin"] or ["Politics", "Elections", "Trump"]. Tags vary by venue: Polymarket markets carry several, Kalshi typically one.

tickSizenumber

Minimum price increment (e.g., 0.01, 0.001)

statusstring

Venue-native lifecycle status (e.g. 'active', 'closed', 'archived').

contractAddressstring

On-chain contract / condition identifier where applicable (Polymarket conditionId, etc.).

sourceMetadataobject

Raw venue-specific metadata not captured by first-class fields (e.g. Kalshi series_ticker / series_title from the parent event, Polymarket series). Passed through verbatim so downstream consumers can recover anything the unified shape omits. Each venue populates what it has.

sourceExchangestring

The exchange/venue this market originates from (e.g. 'polymarket', 'kalshi'). Populated by the Router.

Pass a UnifiedMarket directly instead of marketId/slug/url.

marketIdstring

Lookup a specific market by ID. Omit for browse mode.

slugstring

urlstring

minConfidencenumber

limitnumber

includePricesboolean

minDifferencenumber

Minimum price difference between venues. Browse mode only.

sort'confidence' | 'volume' | 'priceDifference'

Sort order. Browse mode only.

Response

Find Hedging Opportunities response

successboolean

Example response

{
  "success": true
}