@0xinsider/mcp 3.4.1 → 3.5.0

package/dist/sdk/schema.d.ts

@@ -1046,7 +1046,7 @@ export type ExploreMarket = {
     no_change_pct_24h: number | null;
     /** Backend-owned deterministic market discovery score used by the hot sort. */
     discover_score: number | null;
-    score_components?: {
+    score_components: {
         volume_signal: number | null;
         /** Canonical key since #16304; whale_signal is its deprecated spelling, emitted beside it with the same value. */
         large_trade_signal: number | null;
@@ -1063,7 +1063,7 @@ export type ExploreMarket = {
         price_move_signal: number | null;
         missing_price_penalty: number;
     };
-    freshness?: {
+    freshness: {
         enrichment_status: "available" | "unavailable";
         price_status: "available" | "unavailable";
     };
@@ -1083,6 +1083,40 @@ export type ExportCounts = {
     estimated_trade_rows: number;
     estimated_size_mb: number;
 };
+/** `export_job_cancelled` data: the owner's export stopped because its owner cancelled it. */
+export type ExportJobCancelledData = {
+    job_id: number;
+    status: "cancelled";
+    format: string;
+    next_action: "resubmit";
+};
+/** `export_job_expired` data: the owner's ready export passed retention. */
+export type ExportJobExpiredData = {
+    job_id: number;
+    status: "expired";
+    format: string;
+    next_action: "resubmit";
+};
+/** `export_job_failed` data: the owner's asynchronous export reached a terminal failure. */
+export type ExportJobFailedData = {
+    job_id: number;
+    status: "failed";
+    format: string;
+    next_action: "resubmit";
+    failure_reason: string;
+};
+/** `export_job_ready` data: the owner's asynchronous export can be downloaded. Download authorization stays on the status and download routes. */
+export type ExportJobReadyData = {
+    job_id: number;
+    status: "ready";
+    format: string;
+    next_action: "download";
+    total_trades: number | null;
+    processed_trades: number | null;
+    /** Artifact size in bytes. */
+    file_size: number | null;
+    data_as_of: string | null;
+};
 export type ExportSourceRange = {
     first_pnl_date: string | null;
     last_pnl_date: string | null;
@@ -1298,19 +1332,19 @@ export type LargeExportPolicy = {
     /** Programmatic API-key-gated export routes (submit/status/download/cancel) and supported formats (json, ndjson, csv). */
     v1_async: {
         /** POST route template to submit an export job. fresh=true asks for a snapshot read after the submit instead of reusing a finished one. */
-        submit_route?: string;
+        submit_route: string;
         /** GET route template to poll job status. */
-        status_route?: string;
+        status_route: string;
         /** GET route template that 302-redirects to the file. */
-        download_route?: string;
+        download_route: string;
         /** POST route template to cancel a queued or running job. */
-        cancel_route?: string;
+        cancel_route: string;
         /** Supported ?format= values. */
-        formats?: ("json" | "ndjson" | "csv")[];
+        formats: ("json" | "ndjson" | "csv")[];
         /** Possible job status values. */
-        status_values?: ("queued" | "running" | "ready" | "failed" | "reconcile_required" | "expired" | "cancel_requested" | "cancelled")[];
+        status_values: ("queued" | "running" | "ready" | "failed" | "reconcile_required" | "expired" | "cancel_requested" | "cancelled")[];
         /** How long a finished export is retained before expiry. */
-        retention?: string;
+        retention: string;
     };
     direct_streaming: Record<string, unknown>;
     async_job: Record<string, unknown>;
@@ -1387,6 +1421,11 @@ export type LargePosition = {
         category?: string;
     };
 };
+/** `large_positions_updated` data: one large-positions refresh finished. */
+export type LargePositionsUpdatedData = {
+    /** Positions the refresh published. */
+    count: number;
+};
 export type LargeTrade = {
     /** Prefixed ID (wt_...). */
     id: string;
@@ -1458,6 +1497,38 @@ export type LargeTradeHistoryMeta = {
         reason: string;
     };
 };
+/** `large_trade_inserted_v2` data (Pro and Max): one large trade, with the trade itself. The three amounts are decimal strings that keep the stored precision: parse them with a decimal library when the exact value matters. The endpoint's `trade_filters` decide which trades it receives. */
+export type LargeTradeInsertedV2Data = {
+    /** Stable identity of this trade's event. It equals the envelope `id`, and the `id` of the same event on `GET /api/v1/events/feed/since`. */
+    event_id: string;
+    /** Numeric id of the trade. `GET /api/v1/large-trades/{id}` accepts it. */
+    whale_alert_id: number;
+    /** Polymarket condition id of the market. */
+    condition_id: string;
+    /** 0xinsider's numeric id for the wallet. */
+    trader_id: number;
+    /** Address of the wallet that made the trade. */
+    wallet: string;
+    /** The wallet's grade when the event was published; `null` when it has none. */
+    grade: "S" | "A" | "B" | "C" | "D" | "F" | null;
+    /** USD notional of the trade; decimal string. */
+    size_usd: string;
+    /** Shares traded; decimal string. */
+    shares: string;
+    /** Price paid per share; decimal string. */
+    price: string;
+    side: "BUY" | "SELL";
+    /** Polymarket's index of the outcome traded. */
+    outcome_index: number;
+    /** When the trade filled on Polymarket. The envelope's `created_at` is this instant. */
+    traded_at: string;
+    platform: "polymarket";
+};
+/** `large_trades_inserted` data (Pro and Max): new large trades were ingested. It carries a count and no trade; subscribe to `large_trade_inserted_v2` for the trade itself. The deprecated spelling `whale_trades_inserted` delivers the same object. */
+export type LargeTradesInsertedData = {
+    /** Large trades the producing batch admitted. */
+    count: number;
+};
 /** All present fields narrow large_trade_inserted_v2 delivery. Grade is observed at publication; ungraded trades do not match min_grade. An empty object matches every large trade. */
 export type LargeTradeSubscriptionFilters = {
     /** Raw provider condition ID or mkt_-prefixed market ID. */
@@ -1494,6 +1565,48 @@ export type LeaderboardEntry = {
     platform: "polymarket";
     last_active?: string;
 };
+/** One side's score line inside a `live_sports_updated` pulse. */
+export type LiveSportsScoreEntry = {
+    /** Team name, ordered for the league (away first where the league reads that way). */
+    team: string;
+    /** This side's score as the provider sends it. */
+    score: string;
+    /** Esports series only: this side's current-map score. Absent on other sports. */
+    map_score?: string;
+};
+/** `live_sports_updated` data: one bounded pulse for one live game. A pulse fires when a material field moved since this game's previous delivered pulse (`scores`, `status`, `period`, `live`, `ended`), at most once per game per 20 seconds. A `live` or `ended` transition is exempt from that interval, and the game clock alone never fires a pulse. Suppressed frames are folded into the next pulse's `changed`, and its body carries the current state. */
+export type LiveSportsUpdatedData = {
+    /** The Polymarket event slug this game trades under. */
+    event_slug: string;
+    /** Provider game id, or `null` when the frame carried none. */
+    game_id: string | null;
+    /** League abbreviation, or `null`. */
+    league: string | null;
+    /** Durable per-game pulse ordinal, increasing by one per delivered pulse. Deliveries are not ordered, so drop a pulse whose version you already saw. */
+    version: number;
+    /** Material fields that moved since this game's previous delivered pulse. */
+    changed: ("scores" | "status" | "period" | "live" | "ended")[];
+    /** Provider frame time, or `null` when the frame carried none. Never replaced with a local clock. */
+    observed_at: string | null;
+    /** When the pulse was admitted. */
+    published_at: string;
+    /** Provider status text, or `null`. */
+    status: string | null;
+    /** Provider period text ("Q3", "Map 2/3"), or `null`. */
+    period: string | null;
+    /** Game clock, or `null`. Not a material field: it never fires a pulse on its own. */
+    clock: string | null;
+    /** Provider live flag, or `null` when the frame carried none. */
+    live: boolean | null;
+    /** Whether the provider has marked this game final. */
+    ended: boolean;
+    /** Per-side scores, one line per team. */
+    scores: LiveSportsScoreEntry[];
+    /** Esports `BoN` series token, or `null` on every other sport. */
+    series_format: string | null;
+    /** Public game page. Re-read it after a gap instead of replaying pulses. */
+    snapshot_url: string;
+};
 /** Provider-first bucketed OHLC price candles for a market's outcome tokens, derived from our stored copy of the Polymarket CLOB prices-history series (covers open and resolved markets). */
 export type MarketCandles = {
     /** Market condition id the candles were read for. */
@@ -1520,7 +1633,7 @@ export type MarketFlow = {
         /** The Polymarket CLOB token id (ERC1155 asset id, decimal string) for the net-flow direction outcome; null when unavailable (e.g. unsynced markets). */
         token_id: string | null;
         /** Canonical key since #16304 (Polymarket's noun is large trade); whale_trade_count is its deprecated spelling, emitted beside it with the same value. */
-        large_trade_count?: number;
+        large_trade_count: number;
         whale_trade_count: number;
         buy_volume_usd: number;
         sell_volume_usd: number;
@@ -1547,7 +1660,7 @@ export type MarketFlow = {
         /** The Polymarket CLOB token id (ERC1155 asset id, decimal string) for the net-flow direction outcome; null when unavailable (e.g. unsynced markets). */
         token_id: string | null;
         /** Canonical key since #16304 (Polymarket's noun is large trade); whale_trade_count is its deprecated spelling, emitted beside it with the same value. */
-        large_trade_count?: number;
+        large_trade_count: number;
         whale_trade_count: number;
         buy_volume_usd: number;
         sell_volume_usd: number;
@@ -1706,6 +1819,7 @@ export type MarketSnapshot = {
         side: "yes" | "no";
         label: string;
         token_id?: string;
+        /** The outcome's display price, the probability Polymarket shows for it: the midpoint of the cached top of book when the spread is at most 0.10, otherwise the token's last trade price. Omitted when neither is known, including a book wider than 0.10 with no last trade on record; top_of_book still carries that book's best_bid and best_ask. expand=trust explains a missing value in trust.current_price. */
         current_price?: number;
         top_of_book: MarketSnapshotTopOfBook;
     })[];
@@ -1766,7 +1880,7 @@ export type MarketSnapshotTrust = {
 };
 export type McpJsonRpcError = {
     jsonrpc: "2.0";
-    id?: string | number | null;
+    id: string | number | null;
     error: {
         code: number;
         message: string;
@@ -2048,7 +2162,7 @@ export type PickOfTheDayArchiveEntry = {
      * Deprecated compatibility daily release slot; use pick_id for identity and publication_order for scheduling.
      * @deprecated
      */
-    pick_rank?: number;
+    pick_rank: number;
     /** When this selection was published, as RFC3339 UTC. Use this instant for publication feeds and timelines; pick_date is the America/New_York product day, not a publication timestamp. Automatic picks publish from 03:00 America/New_York on pick_date. Absent only for historical rows whose publication instant is unknown. */
     published_at?: string;
     /** Human-readable matchup (e.g. "Portugal vs. Uzbekistan"). */
@@ -2170,7 +2284,7 @@ export type PickOfTheDayHitRate = {
     /** Number of picks still pending resolution (excluded from the hit rate). */
     pending: number;
     /** The flat stake every money figure here assumes, in USD: 1000 since 2026-09-22 (100 before). Always present. */
-    stake_usd?: number;
+    stake_usd: number;
     /** Cumulative profit (USD) of a stake_usd-per-pick strategy over visible valued decided picks: a priced win pays stake_usd/backed_price - stake_usd, every visible loss pays -stake_usd independent of price, and a void pays 0. An unpriced visible win and a current non-Insider row whose price is gated remain in wins/losses but are excluded from price-derived totals. */
     net_profit_usd: number;
     /** Total staked (USD) = stake_usd * count of visible valued decided picks: every visible loss plus every priced win. Void, unpriced wins, and current non-Insider rows whose price is gated are excluded. */
@@ -2222,7 +2336,7 @@ export type PickOfTheDayHitRate = {
     /** Measured public rows where close exactly equals entry. */
     clv_ties: number;
     /** Cumulative track-record series, one point per decided (win/loss) pick in ascending pick_date order (void and pending add no point). A non-valued decided row carries cumulative profit forward while advancing hit rate. The last point's net_profit_usd and hit_rate_pct equal the headline net_profit_usd and pct by construction. Empty when nothing is decided. */
-    series?: {
+    series: {
         /** The decided pick's publish date (YYYY-MM-DD). */
         date: string;
         /** Running cumulative stake_usd-per-pick profit (USD) through this pick; valued losses and priced wins are booked, while a non-valued decided row carries profit forward unchanged. */
@@ -2796,6 +2910,23 @@ export type ScoreCell = {
 };
 /** Shape the provider score string was parsed into. `two_side` is one aggregate per side (basketball `105-98`), `multi_set` is per-set columns (tennis `6-7(5-7), 6-0, 1-0`), `esports_series` is a maps/sets/format triplet (`000-000|2-0|Bo3`). Omitted when the score could not be parsed. */
 export type ScoreFormat = "two_side" | "multi_set" | "esports_series";
+/** `sharp_money_flow_detected` data (Pro and Max): ranked-trader net flow on a market crossed the threshold. The deprecated spelling `smart_money_flow_detected` delivers the same object. */
+export type SharpMoneyFlowDetectedData = {
+    /** Polymarket condition id of the market. */
+    condition_id: string;
+    /** Signed ranked-trader net flow in USD over `window`: positive is net into YES, negative net into NO. */
+    net_flow_usd: number;
+    /** Absolute value of `net_flow_usd`, the magnitude compared with the threshold. */
+    abs_net_flow_usd: number;
+    /** `yes` when `net_flow_usd` is 0 or more, else `no`. */
+    dominant_side: "yes" | "no";
+    /** Minimum trader grade included in the flow. */
+    grade_floor: "S" | "A" | "B" | "C" | "D" | "F";
+    /** Ranked-trader large fills that make up the flow. */
+    whale_trade_count: number;
+    /** Window the flow was aggregated over, for example `24h`. */
+    window: string;
+};
 export type SmartMoneyFlowMarket = {
     market: {
         id: string;
@@ -2813,7 +2944,7 @@ export type SmartMoneyFlowMarket = {
         /** The Polymarket CLOB token id (ERC1155 asset id, decimal string) for the net-flow direction outcome; null when unavailable (e.g. unsynced markets). */
         token_id: string | null;
         /** Canonical key since #16304 (Polymarket's noun is large trade); whale_trade_count is its deprecated spelling, emitted beside it with the same value. */
-        large_trade_count?: number;
+        large_trade_count: number;
         whale_trade_count: number;
         buy_volume_usd: number;
         sell_volume_usd: number;
@@ -2828,7 +2959,7 @@ export type SmartMoneyFlowMarket = {
         /** The Polymarket CLOB token id (ERC1155 asset id, decimal string) for the net-flow direction outcome; null when unavailable (e.g. unsynced markets). */
         token_id: string | null;
         /** Canonical key since #16304 (Polymarket's noun is large trade); whale_trade_count is its deprecated spelling, emitted beside it with the same value. */
-        large_trade_count?: number;
+        large_trade_count: number;
         whale_trade_count: number;
         buy_volume_usd: number;
         sell_volume_usd: number;
@@ -2841,7 +2972,7 @@ export type SnapshotCompleteness = {
     reason: string;
     expected_days: number;
     /** Canonical key since #16304; covered_days_with_whale_activity is its deprecated spelling, emitted beside it with the same value. */
-    covered_days_with_large_trade_activity?: number;
+    covered_days_with_large_trade_activity: number;
     covered_days_with_whale_activity: number;
 };
 export type SnapshotState = {
@@ -2894,6 +3025,27 @@ export type SuspiciousTrade = {
     /** Stored trade timestamp. */
     created_at: string;
 };
+/** `suspicious_trade_flagged` data (Pro and Max): a trade's suspicion score crossed the flag threshold for the first time. The deprecated spelling `insider_radar_flag_raised` delivers the same object. */
+export type SuspiciousTradeFlaggedData = {
+    /** Numeric id of the flagged trade, a JSON number. It is the `id` that `GET /api/v1/large-trades/{id}` accepts. */
+    trade_id: number;
+    /** Address of the wallet that made the trade. */
+    wallet: string;
+    /** 0xinsider's numeric id for the wallet. */
+    trader_id: number;
+    /** Polymarket condition id of the market. */
+    condition_id: string;
+    /** The suspicion score, 0 to 100, that crossed the threshold. */
+    suspicion_score: number;
+    /** The scoring track that raised the flag. */
+    track: "whale" | "fresh_conviction" | "sliced_position";
+    /** Outcome side the flagged fill took. */
+    side: "yes" | "no";
+    /** Share count of the flagged fill. */
+    size: number;
+    /** Fill price of the flagged trade. */
+    price: number;
+};
 /** Optional current-game tennis facts from API-Tennis, aligned with live_score.scores display order. These facts have their own revision and expiry; Polymarket remains the source of sets, match status, period, and the outer live-score revision. New observations require corroborated identity, current set/games, and live state. Cached responses and replayed frames may still carry expired facts, so clients must enforce expires_at. */
 export type TennisPoints = {
     source: "api_tennis";
@@ -2973,7 +3125,7 @@ export type Trader = {
     };
     strategy?: {
         /** Observed trading style identifier. New rows use two_sided, category_focused, high_activity, diversified, mixed, or unclassified. Historical identifiers remain readable during normal reclassification; style does not predict skill or intent. */
-        strategy_type?: string;
+        strategy_type: string;
         description?: string;
         confidence?: number;
     };
@@ -3364,6 +3516,13 @@ export type TraderStatsExact = {
     /** stats.total_volume as an exact decimal: full-history both-sides cash volume in USD, Polymarket user-volume `volume_usdc`, from the verified `trader_usd_volume` observation. Never Polymarket's share count. */
     total_volume: ExactDecimal;
 };
+/** `trader_synced` data: a tracked wallet finished a sync pass and has a fresh grade. The deprecated spelling `whale_trader_synced` delivers the same object. */
+export type TraderSyncedData = {
+    /** 0xinsider's numeric id for the wallet. */
+    trader_id: number;
+    /** Proxy wallet address. */
+    wallet: string;
+};
 /** Field-level trust metadata returned only when GET /api/v1/trader/{address} includes expand=trust. */
 export type TraderTrust = {
     total_pnl: TrustMetadata;
@@ -3501,8 +3660,6 @@ export type Usage = {
             pay_as_you_go: boolean;
             /** The most requests this account is admitted in a UTC calendar month once enforcement has begun: limit, or four times limit with pay as you go on (2,000,000 for Pro). null for an admin account, which no number stops. Additive since 2026-09-22. */
             ceiling: number | null;
-            /** A historical usage price has not been reconciled to this plan allowance. Pay as you go remains unavailable until billing reconciliation. */
-            unavailable_reason?: "usage_price_reconciliation_required" | null;
         } | null;
     };
     meta: ResponseMeta;
@@ -3511,6 +3668,24 @@ export type VerifyWebhookRequest = {
     /** The one-time token returned on create or on a url change. It is necessary but not sufficient: the destination must also answer the signed webhook.verification challenge with a 2xx. */
     verification_token: string;
 };
+/** `wallet_grade_changed` data (Pro and Max): a tracked wallet's grade moved on a re-grade. */
+export type WalletGradeChangedData = {
+    /** Lowercased proxy wallet address. */
+    wallet: string;
+    /** 0xinsider's numeric id for the wallet. */
+    trader_id: number;
+    /** The grade before the move. Never equal to `new_grade`. */
+    old_grade: "S" | "A" | "B" | "C" | "D" | "F";
+    new_grade: "S" | "A" | "B" | "C" | "D" | "F";
+    /** `upgrade` when `new_grade` is better than `old_grade`, else `downgrade`. */
+    direction: "upgrade" | "downgrade";
+    /** Cohort skill index that drove the grade, 0 to 1. */
+    skill_index: number;
+    /** Final 0 to 100 score banded into the new grade. */
+    final_score: number;
+    /** The ranking date of the re-grade. */
+    date: string;
+};
 /** Owner-scoped view of one webhook delivery attempt. Deliberately omits the request body and the endpoint signing secret: a delivery log never re-exposes the payload or any secret material. */
 export type WebhookDelivery = {
     id: number;
@@ -3737,6 +3912,28 @@ export type WhaleDatasetTrade = {
     trade_event_id: string;
     source_trade_ingested_at: string | null;
 };
+/**
+ * The `data` payload of each webhook event type, from the document's
+ * `webhooks` map. Two spellings of one event share one payload.
+ */
+export interface WebhookEventData {
+    export_job_cancelled: ExportJobCancelledData;
+    export_job_expired: ExportJobExpiredData;
+    export_job_failed: ExportJobFailedData;
+    export_job_ready: ExportJobReadyData;
+    insider_radar_flag_raised: SuspiciousTradeFlaggedData;
+    large_positions_updated: LargePositionsUpdatedData;
+    large_trade_inserted_v2: LargeTradeInsertedV2Data;
+    large_trades_inserted: LargeTradesInsertedData;
+    live_sports_updated: LiveSportsUpdatedData;
+    sharp_money_flow_detected: SharpMoneyFlowDetectedData;
+    smart_money_flow_detected: SharpMoneyFlowDetectedData;
+    suspicious_trade_flagged: SuspiciousTradeFlaggedData;
+    trader_synced: TraderSyncedData;
+    wallet_grade_changed: WalletGradeChangedData;
+    whale_trader_synced: TraderSyncedData;
+    whale_trades_inserted: LargeTradesInsertedData;
+}
 /**
  * The `data` payload each operation answers with: what
  * `ApiClient.call<T>` resolves to, and the default `T` of every
@@ -3853,6 +4050,8 @@ export interface OperationData {
         error?: {
             code: number;
             message: string;
+            /** Optional JSON-serializable error data. */
+            data?: Record<string, unknown> | unknown[] | string | number | boolean | null;
         };
     };
     createWebhook: WebhookEndpoint;
@@ -3882,10 +4081,10 @@ export interface OperationData {
     getEventReplaySince: EventReplayEvent[];
     getGame: Game;
     getHealth: {
-        status?: "ok" | "degraded" | "down" | "maintenance";
-        db?: boolean;
-        cache?: boolean;
-        subsystems?: {
+        status: "ok" | "degraded" | "down" | "maintenance";
+        db: boolean;
+        cache: boolean;
+        subsystems: {
             /** Whether the webhook outbox schema validated on this probe. false lowers status to degraded. true during a maintenance window, when nothing is probed. */
             webhook_compatibility: boolean;
             /** Public-safe aggregate status for expected background job successful-completion heartbeats. Does not expose Redis keys, job names, raw errors, provider payloads, wallet addresses, or condition IDs. */
@@ -4011,8 +4210,6 @@ export interface OperationData {
             pay_as_you_go: boolean;
             /** The most requests this account is admitted in a UTC calendar month once enforcement has begun: limit, or four times limit with pay as you go on (2,000,000 for Pro). null for an admin account, which no number stops. Additive since 2026-09-22. */
             ceiling: number | null;
-            /** A historical usage price has not been reconciled to this plan allowance. Pay as you go remains unavailable until billing reconciliation. */
-            unavailable_reason?: "usage_price_reconciliation_required" | null;
         } | null;
     };
     getWebhook: WebhookEndpoint;
@@ -5118,6 +5315,8 @@ export interface OperationResponse {
         error?: {
             code: number;
             message: string;
+            /** Optional JSON-serializable error data. */
+            data?: Record<string, unknown> | unknown[] | string | number | boolean | null;
         };
     };
     createWebhook: {