@structbuild/sdk 0.3.4 → 0.3.6

package/dist/generated/polymarket.d.ts

@@ -703,6 +703,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/polymarket/trader/leaderboard": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get trader leaderboard
+         * @description Global trader leaderboard ranked by PnL or volume over the selected timeframe. Each entry carries the trader's identity, ranking score (`pnl`), and the full set of Struct trading metrics (volumes split by side, markets_won / markets_lost, win rate, average PnL per market and per trade, average hold time, best trade, fees, and first / last trade timestamps). Enrichment fields are `null` when we don't yet have a row for that address in the selected timeframe.
+         */
+        get: operations["get_polymarket_leaderboard"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/polymarket/trader/pnl/{address}": {
         parameters: {
             query?: never;
@@ -1380,6 +1400,76 @@ export interface components {
             /** Format: int64 */
             last_trade_at?: number | null;
         };
+        /**
+         * @description Market category filter for the trader leaderboard.
+         *     Mirrors `common::gamma::categories::Category` plus `overall` (= all).
+         * @enum {string}
+         */
+        LeaderboardCategory: "overall" | "politics" | "sports" | "crypto" | "finance" | "culture" | "mentions" | "weather" | "economics" | "tech";
+        /**
+         * @description Flat response row. `trader` is the canonical `TraderInfo` used across all
+         *     our other endpoints; all enrichment fields sit at the top level. Fields
+         *     other than `trader`, `rank`, `pnl`, and `timeframe` are sourced from our
+         *     `prediction_trader_pnl_*_v2` tables and are `null` when we don't yet have
+         *     a row for that address in the selected timeframe.
+         */
+        LeaderboardEntry: {
+            /** Format: int64 */
+            rank?: number | null;
+            trader: components["schemas"]["TraderInfo"];
+            /** Format: double */
+            pnl?: number | null;
+            /** Format: int64 */
+            events_traded?: number | null;
+            /** Format: int64 */
+            markets_traded?: number | null;
+            /** Format: int64 */
+            markets_won?: number | null;
+            /** Format: int64 */
+            markets_lost?: number | null;
+            /** Format: double */
+            market_win_rate_pct?: number | null;
+            /** Format: double */
+            total_volume_usd?: number | null;
+            /** Format: double */
+            buy_volume_usd?: number | null;
+            /** Format: double */
+            sell_volume_usd?: number | null;
+            /** Format: double */
+            redemption_volume_usd?: number | null;
+            /** Format: double */
+            merge_volume_usd?: number | null;
+            /** Format: int64 */
+            total_buys?: number | null;
+            /** Format: int64 */
+            total_sells?: number | null;
+            /** Format: int64 */
+            total_redemptions?: number | null;
+            /** Format: int64 */
+            total_merges?: number | null;
+            /** Format: int64 */
+            total_trades?: number | null;
+            /** Format: double */
+            total_fees?: number | null;
+            /** Format: double */
+            avg_pnl_per_market?: number | null;
+            /** Format: double */
+            avg_pnl_per_trade?: number | null;
+            /** Format: double */
+            avg_hold_time_seconds?: number | null;
+            /** Format: double */
+            best_trade_pnl_usd?: number | null;
+            best_trade_condition_id?: string | null;
+            /** Format: int64 */
+            first_trade_at?: number | null;
+            /** Format: int64 */
+            last_trade_at?: number | null;
+        };
+        /**
+         * @description Sort key for the trader leaderboard (`GET /polymarket/trader/leaderboard`).
+         * @enum {string}
+         */
+        LeaderboardSortBy: "pnl" | "volume";
         /** @description Response for market (condition_id) holders endpoint */
         MarketHoldersResponse: {
             /** @description Market condition ID */
@@ -4420,6 +4510,51 @@ export interface operations {
             };
         };
     };
+    get_polymarket_leaderboard: {
+        parameters: {
+            query?: {
+                /** @description Aggregation window (default: lifetime) */
+                timeframe?: components["schemas"]["PnlTimeframe"];
+                /** @description Order by: pnl or volume (default: pnl). Case-insensitive. */
+                sort_by?: components["schemas"]["LeaderboardSortBy"];
+                /** @description Rows per page, 1..=50 (default: 20) */
+                limit?: number;
+                /** @description Offset for pagination (default: 0) */
+                offset?: number;
+                /** @description Market category filter. Case-insensitive. Default: overall. */
+                category?: components["schemas"]["LeaderboardCategory"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Leaderboard rows with full trader metrics. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LeaderboardEntry"][];
+                };
+            };
+            /** @description Bad request — invalid timeframe, sort_by, or category */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Leaderboard unavailable */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     get_trader_pnl: {
         parameters: {
             query?: {

package/dist/generated/ws.d.ts

@@ -2,101 +2,110 @@ export type paths = Record<string, never>;
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        /** @description Server-pushed CLOB reward change event. Envelope type: "clob_rewards_update". */
-        ClobRewardsUpdateEvent: {
-            /**
-             * @description Type of change
-             * @enum {string}
-             */
-            event_type?: "added" | "removed" | "updated";
-            /** @description Affected market condition ID */
-            condition_id?: string;
-            /** @description Full reward state (null for 'removed' events) */
-            reward?: {
-                condition_id?: string;
-                rewards_config?: {
-                    id?: number;
-                    /** @description Reward token address (e.g. USDC) */
-                    asset_address?: string;
-                    /** Format: date */
-                    start_date?: string;
-                    /** Format: date */
-                    end_date?: string;
-                    /** @description Daily reward rate in USDC */
-                    rate_per_day?: number;
-                    /** @description Cumulative rewards distributed */
-                    total_rewards?: number;
-                }[];
-                /** @description Max spread to qualify for rewards */
-                rewards_max_spread?: number | null;
-                /** @description Min order size to qualify for rewards */
-                rewards_min_size?: number | null;
-                /** @description Native (non-sponsored) daily rate */
-                native_daily_rate?: number | null;
-                /** @description Sponsored daily rate */
-                sponsored_daily_rate?: number | null;
-                /** @description Combined daily rate (native + sponsored) */
-                total_daily_rate?: number | null;
-                /** @description Number of sponsors */
-                sponsors_count?: number | null;
-            } | null;
-            /** @description Unix timestamp in milliseconds */
-            timestamp_ms?: number;
-        };
-        /** @description Server acknowledgement for a CLOB rewards subscription. Envelope type: "clob_rewards_stream_subscribe_response". */
-        ClobRewardsSubscribeResponse: {
-            /** @description Accepted condition IDs */
-            condition_ids?: string[];
-            /** @description Whether subscribed to all changes */
-            subscribe_all?: boolean;
-            /** @description Filter values that were rejected */
-            rejected?: string[];
+        /** @description Server-pushed event: one or more open markets matching this subscription had a field change since the last tick. Envelope type: "markets_stream_update". Only rows that changed AND matched are in `data`. Client merges by `condition_id`. Each outcome in `data[i].outcomes` carries `latest_block` + `latest_confirmed_at` price-update watermarks. */
+        MarketsStreamUpdateEvent: {
+            /** @enum {string} */
+            type: "markets_stream_update";
+            /** @enum {string} */
+            room_id: "polymarket_markets_stream";
+            /** @enum {string} */
+            mode: "filter" | "ids";
+            /** @enum {integer} */
+            interval_ms: 500 | 1000 | 3000 | 10000;
+            /** @description Full market rows (same shape as `GET /polymarket/market`). Not a delta — each element is a complete row replacement. */
+            data: Record<string, never>[];
         };
-        /** @description Subscribe to CLOB reward changes. Either provide specific condition_ids or set subscribe_all to true. */
-        ClobRewardsSubscribeMessage: {
+        /** @description Server acknowledgement for a markets_stream subscribe/unsubscribe. Envelope type: "markets_stream_subscribe_response". */
+        MarketsStreamSubscribeResponse: {
             /** @enum {string} */
-            action: "subscribe" | "unsubscribe_all";
-            /** @description Condition IDs to watch for reward changes. */
+            mode?: "filter" | "ids" | "";
+            interval_ms?: number;
+            /** @description Accepted condition_ids (ids mode). */
             condition_ids?: string[];
-            /** @description If true, receive ALL reward changes across all markets. Overrides condition_ids. */
-            subscribe_all?: boolean;
+            market_slugs?: string[];
+            event_slugs?: string[];
+            /** @description Ids that failed normalization or exceeded the per-sub cap. */
+            rejected?: string[];
+            /** @description Non-null when the subscribe was rejected. */
+            error?: string | null;
         };
-        /** @description Server-pushed event: full CLOB orderbook snapshot for an outcome token. Envelope type: "order_book_update". Delivered whenever the book changes for a subscribed condition or position. */
-        OrderBookUpdateEvent: {
-            /** @description Hex token ID (position / outcome token) */
-            asset_id: string;
-            /** @description Condition ID (hex) */
-            market: string;
-            /** @description Bid levels sorted best-first (highest price first) */
-            bids: components["schemas"]["OrderBookLevel"][];
-            /** @description Ask levels sorted best-first (lowest price first) */
-            asks: components["schemas"]["OrderBookLevel"][];
+        /** @description List-API-shaped filter evaluated in-memory against changed rows. `status` is NOT accepted — the cache only holds open markets. */
+        MarketsStreamFilter: {
+            /** @description Case-insensitive substring match on `title`. 3–100 chars. */
+            search?: string;
+            categories?: string[];
+            exclude_categories?: string[];
+            tags?: string[];
+            exclude_tags?: string[];
+            min_volume?: number;
+            max_volume?: number;
+            min_txns?: number;
+            max_txns?: number;
+            min_unique_traders?: number;
+            max_unique_traders?: number;
+            min_liquidity?: number;
+            max_liquidity?: number;
+            /** Format: int64 */
+            min_holders?: number;
+            /** Format: int64 */
+            max_holders?: number;
             /**
              * Format: int64
-             * @description Unix milliseconds from CLOB message
+             * @description Filter markets with `end_time >= start_time` (Unix seconds).
              */
-            timestamp: number;
-            /** @description Orderbook content hash — identical hash means no change */
-            hash: string;
-            /** @description Best bid price (0–1) */
-            best_bid?: number | null;
-            /** @description Best ask price (0–1) */
-            best_ask?: number | null;
-            /** @description (best_bid + best_ask) / 2 */
-            mid_price?: number | null;
-            /** @description best_ask − best_bid */
-            spread?: number | null;
-            /** @description Total USD value of all bid levels */
-            bid_liquidity_usd?: number | null;
-            /** @description Total USD value of all ask levels */
-            ask_liquidity_usd?: number | null;
-            /** @description Number of bid price levels */
-            bid_levels?: number | null;
-            /** @description Number of ask price levels */
-            ask_levels?: number | null;
+            start_time?: number;
+            /**
+             * Format: int64
+             * @description Filter markets with `end_time <= end_time` (Unix seconds).
+             */
+            end_time?: number;
+            /** @description When true, only markets with at least one CLOB reward. */
+            has_rewards?: boolean;
+            /**
+             * @description Timeframe that `volume`/`txns`/`unique_traders` thresholds are evaluated against. Default `24h`.
+             * @enum {string}
+             */
+            timeframe?: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d";
+        };
+        /** @description Subscribe / unsubscribe message for polymarket_markets_stream. */
+        MarketsStreamSubscribeMessage: {
+            /**
+             * @description `subscribe` creates/replaces a slot. `unsubscribe` removes one slot (needs `mode` + `interval_ms`). `unsubscribe_all` removes every slot this client holds in the room.
+             * @enum {string}
+             */
+            action: "subscribe" | "unsubscribe" | "unsubscribe_all";
+            /**
+             * @description Flush cadence. Required for subscribe / unsubscribe. Default 1000 if omitted.
+             * @enum {integer}
+             */
+            interval_ms?: 500 | 1000 | 3000 | 10000;
+            /**
+             * @description Subscription mode. Default `filter`.
+             * @enum {string}
+             */
+            mode?: "filter" | "ids";
+            /** @description Filter body (only used when `mode=filter`). All fields optional. */
+            filter?: components["schemas"]["MarketsStreamFilter"];
+            /** @description Ids mode: 0x-prefixed lowercase 32-byte hex. Counts toward the 500-id cap. */
+            condition_ids?: string[];
+            /** @description Ids mode: market slug strings. */
+            market_slugs?: string[];
+            /** @description Ids mode: event slug strings — matches every child market of each event. */
+            event_slugs?: string[];
+        };
+        /** @description Server-pushed event: one or more open events matching this subscription had a field change since the last tick. Envelope type: "events_stream_update". Only rows that changed AND matched are in `data`. Client merges into its local state by `id`. */
+        EventsStreamUpdateEvent: {
+            /** @enum {string} */
+            type: "events_stream_update";
+            /** @enum {string} */
+            room_id: "polymarket_events_stream";
+            /** @enum {string} */
+            mode: "filter" | "ids";
+            /** @enum {integer} */
+            interval_ms: 500 | 1000 | 3000 | 10000;
+            /** @description Full `PolymarketEvent` rows (same shape as `GET /polymarket/events`). Not a delta — each array element is a complete row replacement. */
+            data: Record<string, never>[];
         };
-        /** @description A single price level: [price_string, size_string] */
-        OrderBookLevel: string[];
         /** @description Subscribe to the trades stream. No filters = subscribe to all trades. */
         TradesStreamSubscribeMessage: {
             /** @enum {string} */
@@ -914,6 +923,158 @@ export interface components {
             /** @description Filter values that were rejected (invalid format or limit exceeded) */
             rejected?: string[];
         };
+        /** @description A single price level: [price_string, size_string] */
+        OrderBookLevel: string[];
+        /** @description Server-pushed event: full CLOB orderbook snapshot for an outcome token. Envelope type: "order_book_update". Delivered whenever the book changes for a subscribed condition or position. */
+        OrderBookUpdateEvent: {
+            /** @description Hex token ID (position / outcome token) */
+            asset_id: string;
+            /** @description Condition ID (hex) */
+            market: string;
+            /** @description Bid levels sorted best-first (highest price first) */
+            bids: components["schemas"]["OrderBookLevel"][];
+            /** @description Ask levels sorted best-first (lowest price first) */
+            asks: components["schemas"]["OrderBookLevel"][];
+            /**
+             * Format: int64
+             * @description Unix milliseconds from CLOB message
+             */
+            timestamp: number;
+            /** @description Orderbook content hash — identical hash means no change */
+            hash: string;
+            /** @description Best bid price (0–1) */
+            best_bid?: number | null;
+            /** @description Best ask price (0–1) */
+            best_ask?: number | null;
+            /** @description (best_bid + best_ask) / 2 */
+            mid_price?: number | null;
+            /** @description best_ask − best_bid */
+            spread?: number | null;
+            /** @description Total USD value of all bid levels */
+            bid_liquidity_usd?: number | null;
+            /** @description Total USD value of all ask levels */
+            ask_liquidity_usd?: number | null;
+            /** @description Number of bid price levels */
+            bid_levels?: number | null;
+            /** @description Number of ask price levels */
+            ask_levels?: number | null;
+        };
+        /** @description Subscribe to CLOB reward changes. Either provide specific condition_ids or set subscribe_all to true. */
+        ClobRewardsSubscribeMessage: {
+            /** @enum {string} */
+            action: "subscribe" | "unsubscribe_all";
+            /** @description Condition IDs to watch for reward changes. */
+            condition_ids?: string[];
+            /** @description If true, receive ALL reward changes across all markets. Overrides condition_ids. */
+            subscribe_all?: boolean;
+        };
+        /** @description Server acknowledgement for a CLOB rewards subscription. Envelope type: "clob_rewards_stream_subscribe_response". */
+        ClobRewardsSubscribeResponse: {
+            /** @description Accepted condition IDs */
+            condition_ids?: string[];
+            /** @description Whether subscribed to all changes */
+            subscribe_all?: boolean;
+            /** @description Filter values that were rejected */
+            rejected?: string[];
+        };
+        /** @description Server-pushed CLOB reward change event. Envelope type: "clob_rewards_update". */
+        ClobRewardsUpdateEvent: {
+            /**
+             * @description Type of change
+             * @enum {string}
+             */
+            event_type?: "added" | "removed" | "updated";
+            /** @description Affected market condition ID */
+            condition_id?: string;
+            /** @description Full reward state (null for 'removed' events) */
+            reward?: {
+                condition_id?: string;
+                rewards_config?: {
+                    id?: number;
+                    /** @description Reward token address (e.g. USDC) */
+                    asset_address?: string;
+                    /** Format: date */
+                    start_date?: string;
+                    /** Format: date */
+                    end_date?: string;
+                    /** @description Daily reward rate in USDC */
+                    rate_per_day?: number;
+                    /** @description Cumulative rewards distributed */
+                    total_rewards?: number;
+                }[];
+                /** @description Max spread to qualify for rewards */
+                rewards_max_spread?: number | null;
+                /** @description Min order size to qualify for rewards */
+                rewards_min_size?: number | null;
+                /** @description Native (non-sponsored) daily rate */
+                native_daily_rate?: number | null;
+                /** @description Sponsored daily rate */
+                sponsored_daily_rate?: number | null;
+                /** @description Combined daily rate (native + sponsored) */
+                total_daily_rate?: number | null;
+                /** @description Number of sponsors */
+                sponsors_count?: number | null;
+            } | null;
+            /** @description Unix timestamp in milliseconds */
+            timestamp_ms?: number;
+        };
+        /** @description Subscribe / unsubscribe message for polymarket_events_stream. */
+        EventsStreamSubscribeMessage: {
+            /**
+             * @description `subscribe` creates/replaces a slot. `unsubscribe` removes one slot (needs `mode` + `interval_ms`). `unsubscribe_all` removes every slot this client holds in the room.
+             * @enum {string}
+             */
+            action: "subscribe" | "unsubscribe" | "unsubscribe_all";
+            /**
+             * @description Flush cadence. Required for subscribe / unsubscribe. Default 1000 if omitted.
+             * @enum {integer}
+             */
+            interval_ms?: 500 | 1000 | 3000 | 10000;
+            /**
+             * @description Subscription mode. Default `filter`.
+             * @enum {string}
+             */
+            mode?: "filter" | "ids";
+            /** @description Filter body (only used when `mode=filter`). All fields optional; omitted fields are unconstrained. */
+            filter?: components["schemas"]["EventsStreamFilter"];
+            /** @description Ids mode: event slugs to watch. Combined with `event_ids` up to 500 total. */
+            event_slugs?: string[];
+            /** @description Ids mode: event ids to watch. Combined with `event_slugs` up to 500 total. */
+            event_ids?: string[];
+        };
+        /** @description List-API-shaped filter evaluated in-memory against changed rows. `status` is NOT an accepted field — the cache only holds open events. */
+        EventsStreamFilter: {
+            /** @description Case-insensitive substring match on `title`. 3–100 chars. */
+            search?: string;
+            categories?: string[];
+            exclude_categories?: string[];
+            /** @description Match by tag slug OR label (case-insensitive). */
+            tags?: string[];
+            exclude_tags?: string[];
+            min_volume?: number;
+            max_volume?: number;
+            min_txns?: number;
+            max_txns?: number;
+            min_unique_traders?: number;
+            max_unique_traders?: number;
+            /**
+             * @description Timeframe that `volume`/`txns`/`unique_traders` thresholds are evaluated against. Default `24h`.
+             * @enum {string}
+             */
+            timeframe?: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d";
+        };
+        /** @description Server acknowledgement for an events_stream subscribe/unsubscribe. Envelope type: "events_stream_subscribe_response". */
+        EventsStreamSubscribeResponse: {
+            /** @enum {string} */
+            mode?: "filter" | "ids" | "";
+            interval_ms?: number;
+            /** @description Accepted ids (ids mode only). Empty in filter mode. */
+            event_slugs?: string[];
+            /** @description Ids that failed normalization (ids mode). */
+            rejected?: string[];
+            /** @description Non-null when the subscribe was rejected (invalid cadence, bad filter, too many subs, …). */
+            error?: string | null;
+        };
         /**
          * OrderFilled / OrdersMatched
          * @description A buy/sell trade was matched on the exchange.

package/dist/index.cjs

@@ -289,6 +289,14 @@ class HttpClient {
 }
 
 // src/namespaces/base.ts
+function encodePathParam(value) {
+  try {
+    return encodeURIComponent(decodeURIComponent(value));
+  } catch {
+    return encodeURIComponent(value);
+  }
+}
+
 class Namespace {
   http;
   defaultVenue;
@@ -357,7 +365,7 @@ class TagsNamespace extends Namespace {
     return this.get(venue, "/tags", { params: { ...params } });
   }
   async getTag(params, venue) {
-    return this.get(venue, `/tags/${encodeURIComponent(params.identifier)}`);
+    return this.get(venue, `/tags/${encodePathParam(params.identifier)}`);
   }
 }
 // src/namespaces/events.ts
@@ -367,11 +375,11 @@ class EventsNamespace extends Namespace {
   }
   async getEvent(params, venue) {
     const { identifier, ...query } = params;
-    return this.get(venue, `/events/${encodeURIComponent(identifier)}`, { params: { ...query } });
+    return this.get(venue, `/events/${encodePathParam(identifier)}`, { params: { ...query } });
   }
   async getEventBySlug(params, venue) {
     const { slug, ...query } = params;
-    return this.get(venue, `/events/slug/${encodeURIComponent(slug)}`, { params: { ...query } });
+    return this.get(venue, `/events/slug/${encodePathParam(slug)}`, { params: { ...query } });
   }
   async getEventChart(params, venue) {
     return this.get(venue, "/events/chart", { params: { ...params } });
@@ -436,7 +444,7 @@ class SeriesNamespace extends Namespace {
   }
   async getSeriesEvents(params, venue) {
     const { identifier, ...query } = params;
-    return this.get(venue, `/series/${encodeURIComponent(identifier)}/events`, { params: { ...query } });
+    return this.get(venue, `/series/${encodePathParam(identifier)}/events`, { params: { ...query } });
   }
 }
 // src/namespaces/trader.ts
@@ -482,6 +490,9 @@ class TraderNamespace extends Namespace {
   async getGlobalPnl(params, venue) {
     return this.get(venue, "/trader/global_pnl", { params: { ...params } });
   }
+  async getLeaderboard(params, venue) {
+    return this.get(venue, "/trader/leaderboard", { params: { ...params } });
+  }
 }
 // src/namespaces/bonds.ts
 class BondsNamespace extends Namespace {
@@ -1356,5 +1367,5 @@ async function* paginate(fetcher, params, pageSize = DEFAULT_PAGE_SIZE) {
   }
 }
 
-//# debugId=C22008EEB4E58D0B64756E2164756E21
+//# debugId=106A97244964134B64756E2164756E21
 //# sourceMappingURL=index.js.map