@structbuild/sdk 0.1.24 → 0.2.0

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import type { Venue } from "./types/common.js";
 import type { RetryConfig, RequestHookInfo, ResponseHookInfo } from "./types/index.js";
-import { AssetsNamespace, HoldersNamespace, TagsNamespace, EventsNamespace, MarketsNamespace, SeriesNamespace, TraderNamespace, BondsNamespace, SearchNamespace, WebhooksNamespace } from "./namespaces/index.js";
+import { AssetsNamespace, HoldersNamespace, TagsNamespace, EventsNamespace, MarketsNamespace, SeriesNamespace, TraderNamespace, BondsNamespace, SearchNamespace, OrderBookNamespace, WebhooksNamespace } from "./namespaces/index.js";
 export interface StructClientConfig {
     apiKey: string;
     baseUrl?: string;
@@ -21,6 +21,7 @@ export declare class StructClient {
     readonly trader: TraderNamespace;
     readonly bonds: BondsNamespace;
     readonly search: SearchNamespace;
+    readonly orderBook: OrderBookNamespace;
     readonly webhooks: WebhooksNamespace;
     constructor(config: StructClientConfig);
 }

package/dist/generated/polymarket.d.ts

@@ -483,6 +483,86 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/polymarket/order-book": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get order book
+         * @description Returns the latest CLOB orderbook snapshot for a position, including derived metrics (best bid/ask, mid price, spread, liquidity depth). Data is sourced from the real-time Polymarket WebSocket feed. `bids` and `asks` are arrays of `{"p": price, "s": size}` objects, sorted best-first.
+         */
+        get: operations["get_order_book"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/polymarket/order-book/history": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get order book history
+         * @description Paginated history of raw CLOB orderbook snapshots including full bids/asks levels and derived metrics. Default limit 20, max 200. `bids` and `asks` are arrays of `{"p": price, "s": size}` objects, sorted best-first.
+         */
+        get: operations["get_order_book_history"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/polymarket/order-book/market": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get order books for a market
+         * @description Returns the latest orderbook snapshot for every position (outcome) in a market. Accepts condition_id or market_slug. `bids` and `asks` are arrays of `{"p": price, "s": size}` objects, sorted best-first.
+         */
+        get: operations["get_market_order_book"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/polymarket/order-book/spread": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get spread history
+         * @description Lightweight time series of derived orderbook metrics (best bid/ask, mid price, spread, liquidity depth) without raw bids/asks — ideal for charting. Default limit 100, max 1000.
+         */
+        get: operations["get_spread_history"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/polymarket/search": {
         parameters: {
             query?: never;
@@ -492,13 +572,7 @@ export interface paths {
         };
         /**
          * Search events, markets, and traders
-         * @description Search across events, markets, and traders simultaneously.
-         *
-         *     All three categories are queried in parallel. Each has independent cursor-based pagination via its own `*_pagination_key`.
-         *
-         *     **Trader search** matches by wallet address (exact, `0x...` 42 chars) or by display name / pseudonym (case-insensitive partial match).
-         *
-         *     **sort_by / timeframe** apply to events and markets. Some sort fields only apply to one category (e.g. `liquidity` and `holders` are markets-only; `title`, `creation_date`, `start_date`, `end_date` are events-only) — unrecognised fields fall back to `volume`.
+         * @description Search across markets, events, and traders. Trader search supports wallet address lookup or name search. Results for each category are independently paginated.
          */
         get: operations["search"];
         put?: never;
@@ -826,7 +900,7 @@ export interface components {
         /** @enum {string} */
         AssetSymbol: "BTC" | "ETH" | "XRP" | "SOL";
         /** @enum {string} */
-        AssetVariant: "5m" | "15m" | "1h" | "1d";
+        AssetVariant: "5m" | "15m" | "1h" | "4h" | "1d";
         BondMarket: {
             condition_id: string;
             title?: string | null;
@@ -881,6 +955,31 @@ export interface components {
             /** Format: int32 */
             unique_traders: number;
         };
+        ConditionOrderbookRow: {
+            /** Format: int64 */
+            ts: number;
+            position_id: string;
+            condition_id: string;
+            bids: components["schemas"]["OrderbookLevel"][];
+            asks: components["schemas"]["OrderbookLevel"][];
+            hash: string;
+            /** Format: double */
+            best_bid?: number | null;
+            /** Format: double */
+            best_ask?: number | null;
+            /** Format: double */
+            mid_price?: number | null;
+            /** Format: double */
+            spread?: number | null;
+            /** Format: double */
+            bid_liquidity_usd?: number | null;
+            /** Format: double */
+            ask_liquidity_usd?: number | null;
+            /** Format: int32 */
+            bid_levels?: number | null;
+            /** Format: int32 */
+            ask_levels?: number | null;
+        };
         /** @description Enriched market data for event API responses */
         EventMarket: {
             /** @default  */
@@ -1207,6 +1306,8 @@ export interface components {
             metrics?: {
                 [key: string]: components["schemas"]["SimpleTimeframeMetrics"];
             };
+            /** Format: double */
+            relevance_score?: number | null;
         };
         /** @description Reward info for market API responses */
         MarketReward: {
@@ -1252,6 +1353,63 @@ export interface components {
         };
         /** @enum {string} */
         MetricsTimeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d";
+        OrderbookHistoryRow: {
+            /** Format: int64 */
+            ts: number;
+            position_id: string;
+            condition_id: string;
+            bids: components["schemas"]["OrderbookLevel"][];
+            asks: components["schemas"]["OrderbookLevel"][];
+            hash: string;
+            /** Format: double */
+            best_bid?: number | null;
+            /** Format: double */
+            best_ask?: number | null;
+            /** Format: double */
+            mid_price?: number | null;
+            /** Format: double */
+            spread?: number | null;
+            /** Format: double */
+            bid_liquidity_usd?: number | null;
+            /** Format: double */
+            ask_liquidity_usd?: number | null;
+            /** Format: int32 */
+            bid_levels?: number | null;
+            /** Format: int32 */
+            ask_levels?: number | null;
+        };
+        /** @description A single price level in a bids/asks array. */
+        OrderbookLevel: {
+            /** @description Price as a decimal string */
+            p: string;
+            /** @description Size as a decimal string */
+            s: string;
+        };
+        OrderbookSnapshotRow: {
+            /** Format: int64 */
+            ts: number;
+            position_id: string;
+            condition_id: string;
+            bids: components["schemas"]["OrderbookLevel"][];
+            asks: components["schemas"]["OrderbookLevel"][];
+            hash: string;
+            /** Format: double */
+            best_bid?: number | null;
+            /** Format: double */
+            best_ask?: number | null;
+            /** Format: double */
+            mid_price?: number | null;
+            /** Format: double */
+            spread?: number | null;
+            /** Format: double */
+            bid_liquidity_usd?: number | null;
+            /** Format: double */
+            ask_liquidity_usd?: number | null;
+            /** Format: int32 */
+            bid_levels?: number | null;
+            /** Format: int32 */
+            ask_levels?: number | null;
+        };
         /** @description Holder data grouped by outcome for market-level queries */
         OutcomeHolders: {
             /**
@@ -1750,6 +1908,29 @@ export interface components {
          * @enum {string}
          */
         SpikeDirection: "up" | "down" | "both";
+        /** @description Lightweight row — derived metrics only, no bids/asks JSONB. */
+        SpreadRow: {
+            /** Format: int64 */
+            ts: number;
+            position_id: string;
+            condition_id: string;
+            /** Format: double */
+            best_bid?: number | null;
+            /** Format: double */
+            best_ask?: number | null;
+            /** Format: double */
+            mid_price?: number | null;
+            /** Format: double */
+            spread?: number | null;
+            /** Format: double */
+            bid_liquidity_usd?: number | null;
+            /** Format: double */
+            ask_liquidity_usd?: number | null;
+            /** Format: int32 */
+            bid_levels?: number | null;
+            /** Format: int32 */
+            ask_levels?: number | null;
+        };
         /** @description Token outcome (position) */
         TokenOutcome: {
             token_id: string;
@@ -1923,7 +2104,7 @@ export interface components {
          * @description Timeframe values accepted by webhook metric, milestone, spike, and asset-price filters.
          * @enum {string}
          */
-        WebhookTimeframe: "1m" | "5m" | "15m" | "30m" | "1h" | "6h" | "1d" | "24h" | "7d" | "30d";
+        WebhookTimeframe: "1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "6h" | "1d" | "24h" | "7d" | "30d";
     };
     responses: never;
     parameters: never;
@@ -1938,7 +2119,7 @@ export interface operations {
             query: {
                 /** @description Asset ticker: BTC, ETH, XRP, or SOL */
                 asset_symbol: components["schemas"]["AssetSymbol"];
-                /** @description Time window: 5m, 15m, 1h, or 1d */
+                /** @description Time window: 5m, 15m, 1h, 4h, or 1d */
                 variant: components["schemas"]["AssetVariant"];
                 /** @description Start timestamp (Unix seconds, inclusive) */
                 from?: number;
@@ -2753,7 +2934,55 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        condition_id: string;
+                        id?: string | null;
+                        market_slug?: string | null;
+                        question?: string | null;
+                        title?: string | null;
+                        description?: string | null;
+                        image_url?: string | null;
+                        oracle?: string | null;
+                        status: string;
+                        /** Format: int64 */
+                        created_time?: number | null;
+                        /** Format: int64 */
+                        start_time?: number | null;
+                        /** Format: int64 */
+                        game_start_time?: number | null;
+                        /** Format: int64 */
+                        closed_time?: number | null;
+                        /** Format: int64 */
+                        end_time?: number | null;
+                        accepting_orders?: boolean | null;
+                        uma_resolution_status?: string | null;
+                        is_neg_risk?: boolean | null;
+                        market_maker_address?: string | null;
+                        creator?: string | null;
+                        category?: string | null;
+                        /** Format: double */
+                        volume_usd?: number | null;
+                        /** Format: double */
+                        liquidity_usd?: number | null;
+                        /** Format: double */
+                        highest_probability?: number | null;
+                        /** Format: int64 */
+                        total_holders?: number | null;
+                        winning_outcome?: null | components["schemas"]["MarketOutcome"];
+                        outcomes?: components["schemas"]["MarketOutcome"][];
+                        rewards?: components["schemas"]["MarketReward"][];
+                        clob_rewards?: components["schemas"]["ClobReward"][];
+                        tags?: string[];
+                        event_slug?: string | null;
+                        resolution_source?: string | null;
+                        metrics?: {
+                            [key: string]: components["schemas"]["SimpleTimeframeMetrics"];
+                        };
+                        /** Format: double */
+                        relevance_score?: number | null;
+                    };
+                };
             };
             /** @description Market not found */
             404: {
@@ -2886,7 +3115,55 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        condition_id: string;
+                        id?: string | null;
+                        market_slug?: string | null;
+                        question?: string | null;
+                        title?: string | null;
+                        description?: string | null;
+                        image_url?: string | null;
+                        oracle?: string | null;
+                        status: string;
+                        /** Format: int64 */
+                        created_time?: number | null;
+                        /** Format: int64 */
+                        start_time?: number | null;
+                        /** Format: int64 */
+                        game_start_time?: number | null;
+                        /** Format: int64 */
+                        closed_time?: number | null;
+                        /** Format: int64 */
+                        end_time?: number | null;
+                        accepting_orders?: boolean | null;
+                        uma_resolution_status?: string | null;
+                        is_neg_risk?: boolean | null;
+                        market_maker_address?: string | null;
+                        creator?: string | null;
+                        category?: string | null;
+                        /** Format: double */
+                        volume_usd?: number | null;
+                        /** Format: double */
+                        liquidity_usd?: number | null;
+                        /** Format: double */
+                        highest_probability?: number | null;
+                        /** Format: int64 */
+                        total_holders?: number | null;
+                        winning_outcome?: null | components["schemas"]["MarketOutcome"];
+                        outcomes?: components["schemas"]["MarketOutcome"][];
+                        rewards?: components["schemas"]["MarketReward"][];
+                        clob_rewards?: components["schemas"]["ClobReward"][];
+                        tags?: string[];
+                        event_slug?: string | null;
+                        resolution_source?: string | null;
+                        metrics?: {
+                            [key: string]: components["schemas"]["SimpleTimeframeMetrics"];
+                        };
+                        /** Format: double */
+                        relevance_score?: number | null;
+                    };
+                };
             };
             /** @description Market not found */
             404: {
@@ -2897,6 +3174,271 @@ export interface operations {
             };
         };
     };
+    get_order_book: {
+        parameters: {
+            query: {
+                /** @description Token ID (position ID) to query */
+                position_id: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Latest orderbook snapshot. ts is Unix milliseconds. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: int64 */
+                        ts: number;
+                        position_id: string;
+                        condition_id: string;
+                        bids: components["schemas"]["OrderbookLevel"][];
+                        asks: components["schemas"]["OrderbookLevel"][];
+                        hash: string;
+                        /** Format: double */
+                        best_bid?: number | null;
+                        /** Format: double */
+                        best_ask?: number | null;
+                        /** Format: double */
+                        mid_price?: number | null;
+                        /** Format: double */
+                        spread?: number | null;
+                        /** Format: double */
+                        bid_liquidity_usd?: number | null;
+                        /** Format: double */
+                        ask_liquidity_usd?: number | null;
+                        /** Format: int32 */
+                        bid_levels?: number | null;
+                        /** Format: int32 */
+                        ask_levels?: number | null;
+                    };
+                };
+            };
+            /** @description Missing or invalid parameters */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description No snapshot found for this position */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    get_order_book_history: {
+        parameters: {
+            query?: {
+                /** @description Token ID (required if condition_id / market_slug not set) */
+                position_id?: string;
+                /** @description Condition ID — returns history for all positions in this market */
+                condition_id?: string;
+                /** @description Market slug (alternative to condition_id) */
+                market_slug?: string;
+                /** @description Start timestamp (Unix milliseconds, inclusive) */
+                from?: number;
+                /** @description End timestamp (Unix milliseconds, inclusive) */
+                to?: number;
+                /** @description Only return snapshots with spread >= this value */
+                min_spread?: number;
+                /** @description Only return snapshots with spread <= this value */
+                max_spread?: number;
+                /** @description Only return snapshots where total liquidity (bid + ask) >= this value */
+                min_liquidity?: number;
+                /** @description Number of results (default: 20, max: 200) */
+                limit?: number;
+                /** @description Cursor from previous response's pagination.pagination_key */
+                pagination_key?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Orderbook snapshot rows, newest first. ts is Unix milliseconds. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: int64 */
+                        ts: number;
+                        position_id: string;
+                        condition_id: string;
+                        bids: components["schemas"]["OrderbookLevel"][];
+                        asks: components["schemas"]["OrderbookLevel"][];
+                        hash: string;
+                        /** Format: double */
+                        best_bid?: number | null;
+                        /** Format: double */
+                        best_ask?: number | null;
+                        /** Format: double */
+                        mid_price?: number | null;
+                        /** Format: double */
+                        spread?: number | null;
+                        /** Format: double */
+                        bid_liquidity_usd?: number | null;
+                        /** Format: double */
+                        ask_liquidity_usd?: number | null;
+                        /** Format: int32 */
+                        bid_levels?: number | null;
+                        /** Format: int32 */
+                        ask_levels?: number | null;
+                    }[];
+                };
+            };
+            /** @description Missing or invalid parameters */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    get_market_order_book: {
+        parameters: {
+            query?: {
+                /** @description Condition ID of the market */
+                condition_id?: string;
+                /** @description Market slug (alternative to condition_id) */
+                market_slug?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Latest orderbook snapshot per position. ts is Unix milliseconds. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: int64 */
+                        ts: number;
+                        position_id: string;
+                        condition_id: string;
+                        bids: components["schemas"]["OrderbookLevel"][];
+                        asks: components["schemas"]["OrderbookLevel"][];
+                        hash: string;
+                        /** Format: double */
+                        best_bid?: number | null;
+                        /** Format: double */
+                        best_ask?: number | null;
+                        /** Format: double */
+                        mid_price?: number | null;
+                        /** Format: double */
+                        spread?: number | null;
+                        /** Format: double */
+                        bid_liquidity_usd?: number | null;
+                        /** Format: double */
+                        ask_liquidity_usd?: number | null;
+                        /** Format: int32 */
+                        bid_levels?: number | null;
+                        /** Format: int32 */
+                        ask_levels?: number | null;
+                    }[];
+                };
+            };
+            /** @description Missing or invalid parameters */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Market not found or no snapshots exist */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    get_spread_history: {
+        parameters: {
+            query?: {
+                /** @description Token ID (required if condition_id / market_slug not set) */
+                position_id?: string;
+                /** @description Condition ID — returns spread history for all positions in this market */
+                condition_id?: string;
+                /** @description Market slug (alternative to condition_id) */
+                market_slug?: string;
+                /** @description Start timestamp (Unix milliseconds, inclusive) */
+                from?: number;
+                /** @description End timestamp (Unix milliseconds, inclusive) */
+                to?: number;
+                /** @description Only return rows with spread >= this value */
+                min_spread?: number;
+                /** @description Only return rows with spread <= this value */
+                max_spread?: number;
+                /** @description Only return rows where total liquidity (bid + ask) >= this value */
+                min_liquidity?: number;
+                /** @description Number of results (default: 100, max: 1000) */
+                limit?: number;
+                /** @description Cursor from previous response's pagination.pagination_key */
+                pagination_key?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Spread time series rows, newest first. ts is Unix milliseconds. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: int64 */
+                        ts: number;
+                        position_id: string;
+                        condition_id: string;
+                        /** Format: double */
+                        best_bid?: number | null;
+                        /** Format: double */
+                        best_ask?: number | null;
+                        /** Format: double */
+                        mid_price?: number | null;
+                        /** Format: double */
+                        spread?: number | null;
+                        /** Format: double */
+                        bid_liquidity_usd?: number | null;
+                        /** Format: double */
+                        ask_liquidity_usd?: number | null;
+                        /** Format: int32 */
+                        bid_levels?: number | null;
+                        /** Format: int32 */
+                        ask_levels?: number | null;
+                    }[];
+                };
+            };
+            /** @description Missing or invalid parameters */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     search: {
         parameters: {
             query: {