@agg-build/sdk 1.2.0 → 1.2.11

package/dist/index.d.ts

@@ -454,6 +454,8 @@ type GetHoldingsQuery = {
 type GetOrdersQuery = {
     status?: OrderStatus | undefined;
     orderId?: string | undefined;
+    /** Filter to all legs of one quote (multi-venue split routes). */
+    quoteId?: string | undefined;
     cursor?: string | undefined;
     limit?: number | undefined;
 };
@@ -465,6 +467,12 @@ type GetPositionsQuery = {
 type OrderListItem = {
     status: string;
     id: string;
+    /**
+     * Parent quote — lets the frontend correlate legs of a multi-venue
+     * split route without a second request. Nullable for sell-side /
+     * standalone orders without a Quote row.
+     */
+    quoteId: string | null;
     createdAt: Date;
     updatedAt: Date;
     venue: Venue;
@@ -473,8 +481,28 @@ type OrderListItem = {
     slippageBps: number | null;
     quotedPriceRaw: string | null;
     quotedCostRaw: string | null;
+    /**
+     * Quote-time shares + payout, 6-decimal atomic. Lets the UI render
+     * "Quoted X shares / $Y to win" without re-deriving from cost ÷
+     * price (precision drift on fractional fills; divide-by-zero before
+     * `executionPrice` exists).
+     */
+    quotedSharesRaw: string | null;
+    quotedToWinRaw: string | null;
     filledAmountRaw: string | null;
     executionPrice: string | null;
+    /**
+     * Actual shares + payout, populated by the venue's finalize handler.
+     * Pair with the quoted-side fields above to render the diff inline.
+     */
+    actualSharesRaw: string | null;
+    actualToWinRaw: string | null;
+    /**
+     * Set only on `partial_fill`. One of `"venue_capacity"`,
+     * `"price_slipped"`, `"user_cancelled"`, `"timeout"`, `"bridge_short"`,
+     * or a venue-specific tag.
+     */
+    partialFillReason: string | null;
     txHash: string | null;
     errorMessage: string | null;
     dagRunId: string | null;
@@ -504,7 +532,7 @@ type PositionGroup = {
                 venue: Venue;
                 size: number;
                 venueMarketId: string;
-                venueMarketOutcomeId?: string | null;
+                venueMarketOutcomeId: string;
             }[];
             totalSize: number;
             avgEntryPrice: number;
@@ -532,6 +560,14 @@ type VenueMarket = {
         title?: string | null | undefined;
         externalIdentifier?: string | null | undefined;
         winner?: boolean | null | undefined;
+        /** Counterpart outcomes on matched sibling markets — only populated
+         *  on the parent (queried) market's outcomes. Each entry is a
+         *  `{ venueMarketId, venueMarketOutcomeId }` ref into the same
+         *  response's `matchedVenueMarkets[].venueMarketOutcomes[]`. */
+        matchedVenueMarketOutcomes?: {
+            venueMarketId: string;
+            venueMarketOutcomeId: string;
+        }[];
     }[];
     externalIdentifier: string;
     status?: MarketStatus | undefined;
@@ -604,6 +640,13 @@ type VenueEvent = {
     venues?: Venue[];
     venueCount?: number | undefined;
     marketCount?: number | undefined;
+    /**
+     * ISO-8601 duration denormalized from Series.recurrence. `null` means
+     * the event has no recurring schedule (one-off). Use this value with
+     * the `?recurrence=` filter on /venue-events; discover all available
+     * values via GET /recurrences.
+     */
+    recurrence?: string | null | undefined;
 };
 type Orderbook = {
     bids: {
@@ -696,6 +739,14 @@ type OrderbookHistoryResponse = {
         close?: number | undefined;
     }[];
 };
+/** Reference to a counterpart outcome on a matched sibling market.
+ *  Resolves into the same response's `matchedVenueMarkets[].venueMarketOutcomes[]`
+ *  by id. Sourced from `MatchedVenueMarketOutcome` so the alignment is
+ *  robust to inversely-framed binary markets and multi-outcome markets. */
+type MatchedVenueMarketOutcomeRef = {
+    venueMarketId: string;
+    venueMarketOutcomeId: string;
+};
 type VenueMarketOutcome = {
     id: string;
     price: number;
@@ -704,6 +755,9 @@ type VenueMarketOutcome = {
     title?: string | null | undefined;
     externalIdentifier?: string | null | undefined;
     winner?: boolean | null | undefined;
+    /** Counterpart outcomes on matched sibling markets — only populated on
+     *  the parent (queried) market's outcomes. */
+    matchedVenueMarketOutcomes?: MatchedVenueMarketOutcomeRef[];
 };
 type VenueEventWithMarkets = VenueEvent & {
     venueMarkets: VenueMarket[];
@@ -713,15 +767,31 @@ type VenueEventListItem = VenueEvent & {
     venueMarkets: VenueMarketListItem[];
     marketCount: number;
 };
+/** Per-outcome midpoint inside a matched-sibling entry. Aligned via MVMO
+ *  so the `venueMarketOutcomeId` resolves the same outcome the parent's
+ *  `matchedVenueMarketOutcomes` ref points to. */
+type MatchedMidpointOutcome = {
+    venueMarketOutcomeId: string;
+    midpoint: number | null;
+    bestBid?: number | null;
+    bestAsk?: number | null;
+};
 type MatchedMidpoint = {
     venueMarketId: string;
     venue: string;
+    /** Sibling's market-level midpoint. Kept for backwards compat — the
+     *  authoritative cross-venue alignment lives in `outcomes`. */
     midpoint: number | null;
+    /** Per-outcome midpoints keyed by sibling outcome id. Optional during
+     *  rollout — older engine builds may omit it. */
+    outcomes?: MatchedMidpointOutcome[];
 };
 type OutcomeMidpoint = {
     venueMarketOutcomeId: string;
     label: string;
     midpoint: number | null;
+    bestBid?: number | null;
+    bestAsk?: number | null;
 };
 type MidpointItem = {
     venueMarketId: string;
@@ -964,6 +1034,35 @@ declare function formatMarketQuestion(venue: Venue, market: {
         title?: string | null;
     }>;
 }): string;
+/**
+ * Resolve the display title for a VenueMarketOutcome.
+ *
+ * Returns `null` when every outcome on the market shares the same `title`
+ * (Kalshi binary markets often store the same human-readable phrase on
+ * both Yes/No outcomes — repeating it on each option is redundant). The
+ * frontend should fall back to `label` in that case.
+ *
+ * Otherwise returns the outcome's stored `title` verbatim (or `null` when
+ * unset). The DB `label` is always returned untouched by this helper.
+ *
+ * Polymarket player-prop fallback: when a binary Yes/No outcome has no
+ * stored title (Gamma sends `outcomes=["Yes","No"]` for these markets,
+ * e.g. *"Mikal Bridges: Rebounds O/U 2.5"*), derive `Over`/`Under` from
+ * the question's `O/U <n>` token so the FE has something meaningful to
+ * show. Sports-totals (`["Over","Under"]`) and spread markets
+ * (`["<TeamA>","<TeamB>"]`) already get titles from upstream and are
+ * unaffected.
+ */
+declare function formatOutcomeTitle(_venue: Venue, outcome: {
+    label: string;
+    title?: string | null;
+}, market: {
+    question?: string | null;
+    venueMarketOutcomes?: Array<{
+        label: string;
+        title?: string | null;
+    }>;
+}): string | null;
 
 declare function getWalletAddressFromUserProfile(user: UserProfile | undefined): string | undefined;
 
@@ -1052,6 +1151,31 @@ declare const normalizeVenueMarketCluster: <TMarket extends VenueMarketClusterNo
 
 declare const sortVenues: <T extends string>(venues: readonly T[]) => T[];
 
+/**
+ * Build an external URL to a venue's event/market page.
+ *
+ * Single source of truth — used by API services (market-intel digests,
+ * gap-alerts) AND by the admin Matched Events page to deep-link rows out
+ * to the venue's UI.
+ *
+ * Returns `null` when there isn't enough data to construct a working URL.
+ * Callers should hide the link button rather than render a broken href.
+ *
+ * Per-venue URL conventions are kept here so any future change (e.g.
+ * Kalshi moves to a new path, Polymarket rebrands) is a one-file edit.
+ */
+interface BuildVenueUrlOpts {
+    /** VenueEvent.slug — preferred input for venues that use slug-style URLs. */
+    eventSlug?: string | null;
+    /** VenueEvent.externalIdentifier — used by Kalshi (with series) and as a fallback. */
+    eventExternalId?: string | null;
+    /** VenueEvent.series.externalIdentifier — required for Kalshi's canonical URL. */
+    seriesExternalId?: string | null;
+    /** VenueMarket.conditionId — used as a fallback for Polymarket when slug is missing. */
+    conditionId?: string | null;
+}
+declare function buildVenueUrl(venue: string, opts: BuildVenueUrlOpts): string | null;
+
 /**
  * WebSocket protocol types for the Agg platform.
  * All callback timestamps are in **seconds** (converted from server ms at SDK dispatch).
@@ -1209,6 +1333,28 @@ interface WsOrderEvent {
     stepTypes?: Record<number, string>;
     filledAmountRaw?: string;
     remainingAmountRaw?: string;
+    /**
+     * Quote-time and actual shares + payout. All 6-decimal atomic units
+     * (so 1.234567 shares = "1234567", "$50 to win" = "50000000"). Set
+     * on `filled` / `partial_fill` so the UI can render "Quoted X / Got Y"
+     * without re-deriving from cost ÷ price (which loses precision on
+     * fractional fills and divides by zero before `executionPrice` exists).
+     */
+    quotedSharesRaw?: string;
+    actualSharesRaw?: string;
+    quotedToWinRaw?: string;
+    actualToWinRaw?: string;
+    /** Quote-time price (decimal string, e.g. "0.5"). Pair with `executionPriceRaw`
+     * to render the slippage diff inline. */
+    quotedPriceRaw?: string;
+    /** Actual avg fill price (decimal string). */
+    executionPriceRaw?: string;
+    /**
+     * Set on `partial_fill` events only. One of `"venue_capacity"`,
+     * `"price_slipped"`, `"user_cancelled"`, `"timeout"`, `"bridge_short"`,
+     * or a venue-specific tag.
+     */
+    partialFillReason?: string;
     errorReason?: string;
     attempt?: number;
     correlationId?: string;
@@ -1238,6 +1384,8 @@ interface WsWithdrawalLifecycleLeg {
     amountRaw: string;
     txHash: string | null;
     bridgeOperationId: string | null;
+    /** Human-readable failure reason when `status === "failed"`. Null/absent when succeeded or in-flight. */
+    errorMessage?: string | null;
 }
 /**
  * Per-withdrawal lifecycle event. Wire shape is intentionally additive:
@@ -1248,6 +1396,10 @@ interface WsWithdrawalLifecycleEvent {
     withdrawalId: string;
     userId: string;
     status: WsWithdrawalLifecycleStatus;
+    /** Requested withdrawal amount in destination-token native decimals. */
+    requestedAmountRaw?: string;
+    /** Terminal settled amount in destination-token native decimals. */
+    completedAmountRaw?: string | null;
     /** True when `status` is terminal (`completed` / `partial` / `failed`). */
     terminal: boolean;
     /** Optional leg delta — present when this event was triggered by a leg flip. */
@@ -1494,8 +1646,16 @@ interface AppClientConfigResponse {
     disabledVenues: Venue[];
     disabledCategoryPresets: string[];
     earlyAccessEnabled: boolean;
+    authOptions: AppClientAuthOption[];
 }
 type AggAuthProviderType = "siwe" | "siws" | "google" | "twitter" | "apple" | "email";
+interface AppClientAuthOption {
+    provider: AggAuthProviderType;
+    type: "oauth" | "email" | "wallet";
+    enabled: boolean;
+    callbackUrl?: string;
+    statement?: string;
+}
 type AggAuthDeliveryMode = "body" | "cookie-refresh";
 interface AggClientAuthOptions {
     getEarlyAccessCode?: () => string | null;
@@ -1522,6 +1682,7 @@ interface AggAuthVerifyBody {
 type AggAuthStartResult = {
     type: "nonce";
     nonce: string;
+    statement?: string;
 } | {
     type: "redirect";
     url: string;
@@ -1919,6 +2080,20 @@ interface QuoteManagedResponse {
 }
 interface ExecuteManagedParams {
     quoteId: string;
+    /**
+     * Optional intent fallback. When the supplied `quoteId` has expired in the
+     * cache (e.g. user clicked Buy after a tab was inactive), the server
+     * resolves the latest live quote for this intent and refreshes/executes
+     * against that instead of returning 400 `quote_not_found`. Same intent =
+     * same buttons the user pressed in the UI; a different `maxSpend` is a
+     * different intent and won't match.
+     */
+    fallbackToLatest?: {
+        outcomeId: string;
+        side: "buy" | "sell";
+        maxSpend?: number;
+        sellShares?: number;
+    };
 }
 interface ExecuteManagedResponse {
     quoteId: string;
@@ -1959,6 +2134,8 @@ interface WithdrawalLeg {
     amountRaw: string;
     txHash: string | null;
     bridgeOperationId: string | null;
+    /** Human-readable failure reason when `status === "failed"`. Null when succeeded or in-flight. */
+    errorMessage?: string | null;
 }
 interface WithdrawManagedSourceItem {
     sourceId: string;
@@ -1992,6 +2169,11 @@ interface WithdrawManagedResponse {
         tokenSymbol: WithdrawTokenSymbol;
         amountRaw: string;
     };
+    /**
+     * Terminal settled amount in destination-token native decimals.
+     * Null until at least one source confirms.
+     */
+    completedAmountRaw: string | null;
     destination: {
         chainId: number;
         address: string;
@@ -2196,13 +2378,6 @@ interface SmartRouteVenueFill {
     fills: SmartRouteFill[];
     venueQty: number;
 }
-interface SmartRouteFeeBreakdown {
-    rawExecCost: number;
-    venueFees: number;
-    bridgeFees: number;
-    executionGas: number;
-    totalCost: number;
-}
 interface VenueSoloQuote {
     /**
      * Minted by the API per successful + executable solo; send this to
@@ -2221,6 +2396,17 @@ interface VenueSoloQuote {
     status: string;
     /** Per-price-level fills, identical shape to primary fills. Empty for non-ok statuses. */
     fills: SmartRouteVenueFill[];
+    /**
+     * One-time setup costs for this solo's chosen venue + market. Populated
+     * only when the originating quote opted in via `deepEstimate=true`; absent
+     * on cheap quotes and on non-executable / failed solos. Same shape as the
+     * multi-route `feeBreakdown.setupCosts`. The solo's `estimatedProfit` and
+     * `returnPct` are recomputed against `cost basis + setupCostsTotal` so
+     * per-venue comparisons are setup-inclusive.
+     */
+    setupCosts?: SmartRouteSetupCostLine[];
+    /** Sum of this solo's `setupCosts` entries where `alreadyPaid=false`. */
+    setupCostsTotal?: number;
 }
 /** @deprecated Smart-route side overrides are kept only for source compatibility. */
 type SmartRouteSide = "yes" | "no";
@@ -2243,6 +2429,71 @@ interface SmartRouteParams {
     chainBalances?: Record<string, number>;
     slipCapBps?: number;
     compareVenues?: boolean;
+    /**
+     * Opt in to the deep cost-estimate surface. When `true`, the response
+     * `feeBreakdown` includes `setupCosts` (one-time chain approvals + Kalshi
+     * SPL token-account rents) with per-item `alreadyPaid` flags from the
+     * user's prior trade history. Buy-only; ignored for sells.
+     *
+     * Deep quotes also pre-deduct the unpaid setup total from `maxSpend`
+     * before routing, so `totalCostIncFees` (and the recomputed
+     * `estimatedProfit` / `returnPct`) stay within the partner's stated
+     * budget.
+     */
+    deepEstimate?: boolean;
+}
+/** One-time setup line item — populated only on deep-estimate quotes. */
+interface SmartRouteSetupCostLine {
+    /** "chainApproval" = ERC-20 + venue-contract approvals on the venue's
+     *  chain (Polymarket / Polygon, Limitless / Base, predict.fun / BNB).
+     *  "venueMarketAta" = Kalshi-on-Solana per-market token-account rent. */
+    kind: "chainApproval" | "venueMarketAta";
+    venue: string;
+    /** Set when `kind === "chainApproval"`. */
+    chainId?: number;
+    /** Set when `kind === "venueMarketAta"`. */
+    venueMarketId?: string;
+    /** Per-item cost in USD. Sourced from documented chain-paymaster floors
+     *  (Polygon/Base/Arbitrum ≈ $0.05, BNB $0.20, Solana ATA ≈ $0.30). */
+    costUsd: number;
+    /** True if the user has already paid this on a prior fill — render as a
+     *  strike-through "first-time fee" chip rather than charging again. */
+    alreadyPaid: boolean;
+}
+interface SmartRouteFeeBreakdown {
+    rawExecCost: number;
+    venueFees: number;
+    bridgeFees: number;
+    executionGas: number;
+    totalCost: number;
+}
+/** Cost breakdown for a route quote. */
+interface SmartRouteFeeBreakdown {
+    rawExecCost: number;
+    venueFees: number;
+    bridgeFees: number;
+    executionGas: number;
+    totalCost: number;
+    /** Populated only when the request specified `deepEstimate=true`. */
+    setupCosts?: SmartRouteSetupCostLine[];
+    /** Sum of `setupCosts` entries where `alreadyPaid === false`. */
+    setupCostsTotal?: number;
+    /**
+     * Partner-level execution fee in USD. The worst-case fee the user will
+     * pay against the routed buy notional at quote time. Buy-side only —
+     * sell quotes don't carry this field.
+     *
+     * Actual collection happens after the trade fills, against realized
+     * notional (which may be less on partial fills). Partner UIs should
+     * render this as "you'll pay up to $X in app fees".
+     *
+     * Both `appFee` and `appFeeBips` are present iff `appFee > 0`.
+     */
+    appFee?: number;
+    /** Partner's configured bips for this market — the rate that produced `appFee`. */
+    appFeeBips?: number;
+    /** Category key the bips resolved against (e.g. "sports", or "all" for the fallback). */
+    appFeeCategory?: string;
 }
 /** Response from GET /orderbook/:venueMarketOutcomeId/route. */
 interface SmartRouteResponse {
@@ -2251,6 +2502,12 @@ interface SmartRouteResponse {
     venueMarketId: string;
     estimatedCostRaw: string;
     expiresAt: string;
+    /**
+     * Timestamp at which the quote begins to drift — frontends should refetch
+     * a fresh `getSmartRoute` at this point even though the cached quoteId
+     * remains executable until `expiresAt`. Always earlier than `expiresAt`.
+     */
+    refreshAt: string;
     status: SmartRouteStatus;
     fills: SmartRouteVenueFill[];
     totalFilled: number;
@@ -2268,16 +2525,23 @@ interface SmartRouteResponse {
         venueMarketOutcomeId: string;
         reason: string;
     }>;
-    feeBreakdown?: SmartRouteFeeBreakdown;
     venueSoloQuotes?: VenueSoloQuote[];
     /** Estimated payout if the outcome wins (= totalFilled shares × $1). */
     estimatedPayout?: number;
-    /** Total cost including all fees (rawExecCost + venueFees + bridgeFees + executionGas). */
+    /** Total cost including all fees (rawExecCost + venueFees + bridgeFees +
+     *  executionGas). For deep-estimate quotes, `setupCostsTotal` is folded
+     *  into this number and `estimatedProfit` / `returnPct` are recomputed
+     *  against it. */
     totalCostIncFees?: number;
     /** Estimated profit if the outcome wins (= estimatedPayout − totalCostIncFees). */
     estimatedProfit?: number;
     /** Return on investment percentage (= estimatedProfit / totalCostIncFees × 100). */
     returnPct?: number;
+    /** Per-route fee breakdown. Always present when the engine produced a
+     *  feasible plan; omitted on solo / failed quotes. The `setupCosts` and
+     *  `setupCostsTotal` fields are populated only when the request set
+     *  `deepEstimate=true`. */
+    feeBreakdown?: SmartRouteFeeBreakdown;
     /** Populated only when status === "insufficient_position". */
     positionAvailability?: {
         totalSellableShares: number;
@@ -2320,6 +2584,18 @@ interface SearchParams {
     categoryIds?: string[];
     limit?: number;
     cursor?: string;
+    /**
+     * Opt in to the server-side reranker for higher-quality top results.
+     *
+     * Send `deep: true` for the final search-results page (submit / Enter) and
+     * leave it off for debounced typeahead. Adds ~100–150 ms on a cold rerank
+     * cache and ~3 ms on a warm one — typeahead can't afford the cold cost,
+     * and the result orderings differ enough that the server gives the two
+     * modes separate cache slots.
+     *
+     * Defaults to `false`.
+     */
+    deep?: boolean;
 }
 type SearchResponse<T> = {
     type: SearchType;
@@ -2327,6 +2603,99 @@ type SearchResponse<T> = {
     nextCursor: string | null;
     hasMore: boolean;
 };
+type CorrelatedMarketSide = "yes" | "no";
+type CorrelatedMarketSignalDirection = "more_likely" | "less_likely";
+interface CorrelatedMarketSignal {
+    id: string;
+    text: string;
+    side: CorrelatedMarketSide;
+    direction: CorrelatedMarketSignalDirection;
+    domain: string;
+}
+interface CorrelatedMarketSignalBatch {
+    id: string;
+    venueMarketId: string;
+    sourceModel: string;
+    promptVersion: number;
+    createdAt: string;
+    signals: CorrelatedMarketSignal[];
+}
+interface CorrelatedMarketsStatus {
+    markets: {
+        total: number;
+        processed: number;
+        coverage: number;
+    };
+    signals: {
+        total: number;
+        withEmbeddings: number;
+        missingEmbeddings: number;
+    };
+    eventTitleEmbeddings: {
+        total: number;
+        events: number;
+        coverage: number;
+    };
+    config: {
+        batchSize: number;
+        jobsEnabled: boolean;
+        backfillInterval: string;
+        reembedInterval: string;
+        eventEmbeddingInterval: string;
+    };
+}
+interface CorrelatedMarketQueryResult {
+    venueMarketId: string;
+    marketQuestion: string;
+    eventTitle: string;
+    score: number;
+    matchedSignal: CorrelatedMarketSignal;
+    venue: string;
+}
+interface CorrelatedMarketCascadeItem {
+    venueEventId: string;
+    eventTitle: string;
+    score: number;
+    action: string;
+    reason: string;
+    reasonDomain: string;
+}
+interface CorrelatedMarketCascadeResponse {
+    data: CorrelatedMarketCascadeItem[];
+    nextCursor: string | null;
+    hasMore: boolean;
+}
+interface ResolveCorrelatedMarketsParams {
+    venue?: string;
+    externalId?: string;
+    slug?: string;
+    conditionId?: string;
+    q?: string;
+    side?: CorrelatedMarketSide;
+    mode?: "expand" | "hedge";
+    limit?: number;
+    cursor?: string;
+    includeResolved?: boolean;
+}
+type ResolveCorrelatedMarketsResponse = ({
+    market: {
+        id: string;
+        question: string;
+    };
+} & CorrelatedMarketCascadeResponse) | {
+    market: {
+        id: string;
+        question: string;
+    };
+    status: "processing";
+    message: string;
+};
+interface ResolvedCorrelatedMarketsResponse extends CorrelatedMarketCascadeResponse {
+    market: {
+        id: string;
+        question: string;
+    };
+}
 
 type AuthStateListener = (authenticated: boolean) => void;
 type UserAuthResult = {
@@ -2464,7 +2833,13 @@ declare class AggClient {
     }): Promise<PaginatedResponse<UserHolding>>;
     /** List trade-executor orders for the authenticated user. */
     getOrders(params?: OrderListQuery): Promise<TradeExecutorOrderListResponse>;
-    /** List execution orders for the authenticated user (cursor pagination). */
+    /**
+     * List execution orders for the authenticated user (cursor pagination).
+     *
+     * Pass `quoteId` to fetch every leg of a multi-venue split route in
+     * one call — `useQuoteSummary(quoteId)` reduces the list into a
+     * rollup (total cost, share-weighted avg price, to-win).
+     */
     getExecutionOrders(params?: ExecutionOrdersQuery): Promise<PaginatedResponse<ExecutionOrderItem>>;
     /** Unified user activity feed (trades, deposits, withdrawals, bridges, wallet ops). */
     getUserActivity(params?: UserActivityQuery): Promise<PaginatedResponse<UserActivityItem>>;
@@ -2516,8 +2891,49 @@ declare class AggClient {
     }): Promise<PaginatedResponse<Category>>;
     /** Get per-app UI config (disabled venues + category presets). Requires appId. */
     getAppConfig(init?: RequestInit): Promise<AppClientConfigResponse>;
-    /** Search events or markets by query string. Supports cursor-based pagination. */
+    /**
+     * Search events or markets by query string. Supports cursor-based pagination.
+     *
+     * Pass `deep: true` on submit (Enter / Search button) to opt in to the
+     * server-side reranker. Leave it off for debounced typeahead — the wire
+     * format intentionally omits the param so the server hits the cheaper
+     * (and longer-TTL) light cache slot.
+     */
     search<T = VenueEvent>(params: SearchParams): Promise<SearchResponse<T>>;
+    /** Get Correlated Markets processing and embedding coverage. */
+    getCorrelatedMarketsStatus(options?: {
+        signal?: AbortSignal;
+    }): Promise<CorrelatedMarketsStatus>;
+    /** Get the generated correlated market signals for a market. */
+    getMarketCorrelatedSignals(venueMarketId: string, options?: {
+        signal?: AbortSignal;
+        includeResolved?: boolean;
+    }): Promise<CorrelatedMarketSignalBatch>;
+    /** Search markets by Correlated Markets signal similarity. */
+    queryCorrelatedMarkets(params: {
+        text: string;
+        limit?: number;
+        includeResolved?: boolean;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<{
+        results: CorrelatedMarketQueryResult[];
+    }>;
+    /** Get expansion and hedge candidates for an already-processed market. */
+    getCorrelatedMarketCascade(params: {
+        venueMarketId: string;
+        side?: "yes" | "no";
+        mode?: "expand" | "hedge";
+        limit?: number;
+        cursor?: string;
+        includeResolved?: boolean;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<CorrelatedMarketCascadeResponse>;
+    /** Resolve a market by ID, venue identifier, slug, conditionId, or text, then return candidates. */
+    resolveCorrelatedMarkets(params: ResolveCorrelatedMarketsParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<ResolveCorrelatedMarketsResponse>;
     /** Get the canonical TradingView-style bar series for a single venue market outcome. */
     getChartBars(params: {
         venueMarketOutcomeId: string;
@@ -2538,11 +2954,13 @@ declare class AggClient {
     /** Get live midpoints for the explicit venueMarketIds requested. */
     getMidpoints(params: {
         venueMarketIds: string[];
+        bestPrice?: boolean;
     }, options?: {
         signal?: AbortSignal;
     }): Promise<BatchMidpointsResponse>;
     getMidpoints(venueMarketIds: string[], options?: {
         signal?: AbortSignal;
+        bestPrice?: boolean;
     }): Promise<BatchMidpointsResponse>;
     /** Get a single outcome-level orderbook from the engine. */
     getOutcomeOrderbook(outcomeId: string, options?: {
@@ -2676,4 +3094,4 @@ declare function aggregateMidpoint(midpoints: (number | null | undefined)[]): nu
 
 declare function createAggClient(options: AggClientOptions): AggClient;
 
-export { type Account, AccountProvider, AccountType, type AggAuthDeliveryMode, type AggAuthProviderType, type AggAuthStartBody, type AggAuthStartResult, type AggAuthVerifyBody, AggClient, type AggClientAuthOptions, type AggClientSessionInput, type AggLinkAccountBody, type AggLinkAccountConfirmResult, type AggLinkAccountResult, type AggSessionUser, AggWebSocket, type AggWebSocketCallbacks, type AggWebSocketOptions, type AggregatedOrderbookLevel, type AggregatedOrderbookResponse, type App, type AppClientConfigResponse, type AttributedOrderbook, type AttributedOrderbookLevel, type AuthCodeResponse, type AuthStatus, type AuthTokenResponse, type AuthUser, type BatchMidpointsResponse, type BatchOrderbooksResponse, CONFIRMED_MATCH_STATUSES, type CancelManagedExecutionResponse, type Candle, CandleBuilder, type CandleInterval, type Category, Chain, type ChartBarsResponse, type ChartCandle, type ChartResolution, type ChartVenueCandles, type ComputeSplitsRequest, type ComputeSplitsResponse, type ComputeSplitsSelection, type CreateApp, type DepositAddressesPendingResponse, type DepositAddressesReadyResponse, type DepositAddressesResponse, type DepositAddressesSupportedChain, type DepositAddressesToken, type DepositStep, type DiagnosticCallback, type DiagnosticEvent, type ExecuteManagedParams, type ExecuteManagedRequest, type ExecuteManagedResponse, type ExecuteTradeRequest, type ExecuteTradeResponse, type ExecutionOrderItem, type ExecutionOrdersQuery, type ExecutionPositionGroup, type ExecutionPositionsQuery, type GetBalanceQuery, type GetBalanceResponse, type GetHoldingsQuery, type GetHoldingsResponse, type GetOrdersParams, type GetOrdersQuery, type GetPositionsParams, type GetPositionsQuery, type HelloResponse, IMAGE_SIZES, ImageSize, type MarkSource, type MarketPriceHistory, MarketStatus, MatchStatus, MatchType, type MatchedMidpoint, type MatchedOrderbookMarket, type MatchingReport, type MidpointItem, type MidpointRow, type NonceResponse, type OrderListItem, type OrderListQuery, OrderStatus, type Orderbook, type OrderbookBatchItemError, type OrderbookBatchItemErrorCode, type OrderbookBatchItemStatus, type OrderbookHistoryPoint, type OrderbookHistoryResponse, type OrderbookLevel, type OrderbookQuoteFill, type OrderbookQuoteParams, type OrderbookQuoteResponse, type OrderbookServiceUnavailableError, type OrderbookState, type OrderbooksOnlyError, type OutcomeMidpoint, type OutcomeMidpointRow, type OutcomeOrderbookResponse, type PaginatedResponse, type PersistedAuthSnapshot, type PositionGroup, type PositionRedeemStatus, type PricePoint, type PriceSource, type PricesHistoryResponse, type QuoteManagedParams, type QuoteManagedRequest, type QuoteManagedResponse, type QuoteManagedSplit, type QuoteManagedStep, type QuoteSplit, type QuoteStep, type RampQuote, type RampQuoteRequest, type RampSessionRequest, type RampWidgetSession, type RedeemLegResult, type RedeemLegStatus, type RedeemRequest, type RedeemResponse, type RequestedOrderbookMarket, type SafeParseFailure, type SafeParseResult, type SafeParseSuccess, type ServerWallet, type SettlementSource, type SetupDepositAddressStep, type SetupVenueKeyStep, type SimpleOrderbookLevel, type SmartRouteFill, type SmartRouteParams, type SmartRouteResponse, type SmartRouteSide, type SmartRouteStatus, type SmartRouteVenueFill, type SplitsByAmountResult, type SyncBalancesResponse, type TradeExecutorOrder, type TradeExecutorOrderListResponse, TradeSide$1 as TradeSide, type TradeSplit, type TradeStep, TurnstileChallengeError, type UnifiedBalanceResponse, type UpdateUserBody, type UpsertVenueKey, type UserActivityBridge, type UserActivityDeposit, type UserActivityItem, type UserActivityQuery, type UserActivityTrade, type UserActivityType, type UserActivityUserOp, type UserActivityWithdrawal, type UserHolding, type UserProfile, VENUES, type ValidateBalanceOnClientStep, type ValidateManagedParams, type ValidateManagedRequest, type ValidateManagedResponse, type ValidateTradeRequest, type ValidateTradeResponse, Venue, type VenueEvent, type VenueEventListItem, type VenueEventWithMarkets, type VenueKeySummary, type VenueMarket, type VenueMarketClusterNode, type VenueMarketListItem, type VenueMarketOutcome, type VenueMarketRef, type VenueOrderbookEntry, type VenueOrderbookLevel, type VenuePositionBalance, type VenuePriceInfo, type VenueSoloQuote, type VerifyBody, type VerifyResponse, type WalletChainBalance, type WalletTokenBalance, type WithdrawManagedParams, type WithdrawManagedRequest, type WithdrawManagedResponse, type WithdrawManagedSourceItem, type WithdrawTokenSymbol, type WithdrawalExpected, type WithdrawalLeg, type WithdrawalLegStatus, type WithdrawalLegType, type WithdrawalLifecycleStatus, type WithdrawalSource, type WithdrawalSourceItem, type WithdrawalSourceStatus, type WsAttributedLevel, type WsAuthenticated, type WsBalanceUpdate, type WsCandleInterval, type WsClientMessage, type WsConnected, type WsError, type WsHeartbeat, type WsMarkSource, type WsMarketResolved, type WsOrderEvent, type WsOrderEventType, type WsOrderSubmitted, type WsOrderbookDelta, type WsOrderbookSnapshot, type WsRedeemEvent, type WsServerMessage, type WsSubscribed, type WsTrade, type WsUnsubscribed, type WsVenueBook, type WsVenueInfo, type WsVenueLevel, type WsWithdrawalLegStatus, type WsWithdrawalLifecycleEvent, type WsWithdrawalLifecycleLeg, type WsWithdrawalLifecycleStatus, aggregateMidpoint, applyOrderbookDelta, computeBestSplitsByAmount, computeChecksum, createAggClient, enumGuard, formatMarketQuestion, formatOutcomeLabel, getWalletAddressFromUserProfile, hasShape, isEmail, isEnum, isFiniteNonNeg, isNonEmptyString, mergeCandles, mergeClosedCandles, normalizeVenueMarketCluster, optimizedImageUrl, parse, parseEmail, parseEmailStrict, safeParse, snapshotToOrderbook, sortVenues };
+export { type Account, AccountProvider, AccountType, type AggAuthDeliveryMode, type AggAuthProviderType, type AggAuthStartBody, type AggAuthStartResult, type AggAuthVerifyBody, AggClient, type AggClientAuthOptions, type AggClientSessionInput, type AggLinkAccountBody, type AggLinkAccountConfirmResult, type AggLinkAccountResult, type AggSessionUser, AggWebSocket, type AggWebSocketCallbacks, type AggWebSocketOptions, type AggregatedOrderbookLevel, type AggregatedOrderbookResponse, type App, type AppClientConfigResponse, type AttributedOrderbook, type AttributedOrderbookLevel, type AuthCodeResponse, type AuthStatus, type AuthTokenResponse, type AuthUser, type BatchMidpointsResponse, type BatchOrderbooksResponse, type BuildVenueUrlOpts, CONFIRMED_MATCH_STATUSES, type CancelManagedExecutionResponse, type Candle, CandleBuilder, type CandleInterval, type Category, Chain, type ChartBarsResponse, type ChartCandle, type ChartResolution, type ChartVenueCandles, type ComputeSplitsRequest, type ComputeSplitsResponse, type ComputeSplitsSelection, type CorrelatedMarketCascadeItem, type CorrelatedMarketCascadeResponse, type CorrelatedMarketQueryResult, type CorrelatedMarketSide, type CorrelatedMarketSignal, type CorrelatedMarketSignalBatch, type CorrelatedMarketSignalDirection, type CorrelatedMarketsStatus, type CreateApp, type DepositAddressesPendingResponse, type DepositAddressesReadyResponse, type DepositAddressesResponse, type DepositAddressesSupportedChain, type DepositAddressesToken, type DepositStep, type DiagnosticCallback, type DiagnosticEvent, type ExecuteManagedParams, type ExecuteManagedRequest, type ExecuteManagedResponse, type ExecuteTradeRequest, type ExecuteTradeResponse, type ExecutionOrderItem, type ExecutionOrdersQuery, type ExecutionPositionGroup, type ExecutionPositionsQuery, type GetBalanceQuery, type GetBalanceResponse, type GetHoldingsQuery, type GetHoldingsResponse, type GetOrdersParams, type GetOrdersQuery, type GetPositionsParams, type GetPositionsQuery, type HelloResponse, IMAGE_SIZES, ImageSize, type MarkSource, type MarketPriceHistory, MarketStatus, MatchStatus, MatchType, type MatchedMidpoint, type MatchedMidpointOutcome, type MatchedOrderbookMarket, type MatchedVenueMarketOutcomeRef, type MatchingReport, type MidpointItem, type MidpointRow, type NonceResponse, type OrderListItem, type OrderListQuery, OrderStatus, type Orderbook, type OrderbookBatchItemError, type OrderbookBatchItemErrorCode, type OrderbookBatchItemStatus, type OrderbookHistoryPoint, type OrderbookHistoryResponse, type OrderbookLevel, type OrderbookQuoteFill, type OrderbookQuoteParams, type OrderbookQuoteResponse, type OrderbookServiceUnavailableError, type OrderbookState, type OrderbooksOnlyError, type OutcomeMidpoint, type OutcomeMidpointRow, type OutcomeOrderbookResponse, type PaginatedResponse, type PersistedAuthSnapshot, type PositionGroup, type PositionRedeemStatus, type PricePoint, type PriceSource, type PricesHistoryResponse, type QuoteManagedParams, type QuoteManagedRequest, type QuoteManagedResponse, type QuoteManagedSplit, type QuoteManagedStep, type QuoteSplit, type QuoteStep, type RampQuote, type RampQuoteRequest, type RampSessionRequest, type RampWidgetSession, type RedeemLegResult, type RedeemLegStatus, type RedeemRequest, type RedeemResponse, type RequestedOrderbookMarket, type ResolveCorrelatedMarketsParams, type ResolveCorrelatedMarketsResponse, type ResolvedCorrelatedMarketsResponse, type SafeParseFailure, type SafeParseResult, type SafeParseSuccess, type ServerWallet, type SettlementSource, type SetupDepositAddressStep, type SetupVenueKeyStep, type SimpleOrderbookLevel, type SmartRouteFeeBreakdown, type SmartRouteFill, type SmartRouteParams, type SmartRouteResponse, type SmartRouteSetupCostLine, type SmartRouteSide, type SmartRouteStatus, type SmartRouteVenueFill, type SplitsByAmountResult, type SyncBalancesResponse, type TradeExecutorOrder, type TradeExecutorOrderListResponse, TradeSide$1 as TradeSide, type TradeSplit, type TradeStep, TurnstileChallengeError, type UnifiedBalanceResponse, type UpdateUserBody, type UpsertVenueKey, type UserActivityBridge, type UserActivityDeposit, type UserActivityItem, type UserActivityQuery, type UserActivityTrade, type UserActivityType, type UserActivityUserOp, type UserActivityWithdrawal, type UserHolding, type UserProfile, VENUES, type ValidateBalanceOnClientStep, type ValidateManagedParams, type ValidateManagedRequest, type ValidateManagedResponse, type ValidateTradeRequest, type ValidateTradeResponse, Venue, type VenueEvent, type VenueEventListItem, type VenueEventWithMarkets, type VenueKeySummary, type VenueMarket, type VenueMarketClusterNode, type VenueMarketListItem, type VenueMarketOutcome, type VenueMarketRef, type VenueOrderbookEntry, type VenueOrderbookLevel, type VenuePositionBalance, type VenuePriceInfo, type VenueSoloQuote, type VerifyBody, type VerifyResponse, type WalletChainBalance, type WalletTokenBalance, type WithdrawManagedParams, type WithdrawManagedRequest, type WithdrawManagedResponse, type WithdrawManagedSourceItem, type WithdrawTokenSymbol, type WithdrawalExpected, type WithdrawalLeg, type WithdrawalLegStatus, type WithdrawalLegType, type WithdrawalLifecycleStatus, type WithdrawalSource, type WithdrawalSourceItem, type WithdrawalSourceStatus, type WsAttributedLevel, type WsAuthenticated, type WsBalanceUpdate, type WsCandleInterval, type WsClientMessage, type WsConnected, type WsError, type WsHeartbeat, type WsMarkSource, type WsMarketResolved, type WsOrderEvent, type WsOrderEventType, type WsOrderSubmitted, type WsOrderbookDelta, type WsOrderbookSnapshot, type WsRedeemEvent, type WsServerMessage, type WsSubscribed, type WsTrade, type WsUnsubscribed, type WsVenueBook, type WsVenueInfo, type WsVenueLevel, type WsWithdrawalLegStatus, type WsWithdrawalLifecycleEvent, type WsWithdrawalLifecycleLeg, type WsWithdrawalLifecycleStatus, aggregateMidpoint, applyOrderbookDelta, buildVenueUrl, computeBestSplitsByAmount, computeChecksum, createAggClient, enumGuard, formatMarketQuestion, formatOutcomeLabel, formatOutcomeTitle, getWalletAddressFromUserProfile, hasShape, isEmail, isEnum, isFiniteNonNeg, isNonEmptyString, mergeCandles, mergeClosedCandles, normalizeVenueMarketCluster, optimizedImageUrl, parse, parseEmail, parseEmailStrict, safeParse, snapshotToOrderbook, sortVenues };