@structbuild/sdk 0.3.10-staging.3 → 0.3.10-staging.5

package/dist/generated/polymarket.d.ts

@@ -852,7 +852,7 @@ export interface paths {
         };
         /**
          * Get tags
-         * @description Retrieve all available event tags/categories. Supports both cursor-based and offset-based pagination.
+         * @description Retrieve all available event tags/categories. Default listing is alphabetical (cursor-paginated). If either `sort` or `timeframe` is provided, the listing is ranked by the chosen metric+window (offset-paginated): sort defaults to `volume` when only `timeframe` is set, timeframe defaults to `24h` when only `sort` is set.
          */
         get: operations["get_tags"];
         put?: never;
@@ -872,7 +872,7 @@ export interface paths {
         };
         /**
          * Get tag by slug
-         * @description Retrieve a single tag by its ID or slug
+         * @description Retrieve a single tag by its ID or slug. Pass `include_metrics=true` to attach analytics metrics (volume_usd, txn_count, unique_traders, fees_usd) — adds +1 credit. Use `timeframe` to select the window; defaults to `1d`.
          */
         get: operations["get_tag_by_id"];
         put?: never;
@@ -1641,8 +1641,7 @@ export interface components {
         EventSortBy: "volume" | "txns" | "unique_traders" | "title" | "creation_date" | "start_date" | "end_date" | "relevance";
         /**
          * @description Response body for `GET /polymarket/analytics/counts`.
-         *     Cumulative analytics metrics (from ClickHouse `analytics_global`) plus
-         *     entity-count enrichment (from Postgres `pg_class.reltuples` estimates).
+         *     Cumulative analytics metrics plus entity-count enrichment.
          */
         GlobalCountsResponse: {
             /**
@@ -1691,22 +1690,22 @@ export interface components {
             no_count: number;
             /**
              * Format: int64
-             * @description Estimated row count of `polymarket_tags` (Postgres pg_class.reltuples).
+             * @description Estimated total number of tags.
              */
             tags: number;
             /**
              * Format: int64
-             * @description Estimated row count of `polymarket_events`.
+             * @description Estimated total number of events.
              */
             events: number;
             /**
              * Format: int64
-             * @description Estimated row count of `prediction_markets`.
+             * @description Estimated total number of markets.
              */
             markets: number;
             /**
              * Format: int64
-             * @description Estimated row count of `polymarket_accounts` (traders / positions).
+             * @description Estimated total number of unique positions / traders.
              */
             positions: number;
         };
@@ -2448,6 +2447,26 @@ export interface components {
             label: string;
             /** @default null */
             slug: string | null;
+            /**
+             * Format: double
+             * @default null
+             */
+            volume_usd: number;
+            /**
+             * Format: int64
+             * @default null
+             */
+            txn_count: number;
+            /**
+             * Format: int64
+             * @default null
+             */
+            unique_traders: number;
+            /**
+             * Format: double
+             * @default null
+             */
+            fees_usd: number;
         };
         /** @description Polymarket user profile (public API format) */
         PolymarketUserProfile: {
@@ -2960,11 +2979,30 @@ export interface components {
             ask_levels?: number | null;
         };
         /**
-         * @description Timeseries bucket row.
+         * @description Metric to order by when `sort=<value>` is provided.
+         *     `traders` windowed sums per-block deltas — approximate for the "unique
+         *     traders in window" reading (double-counts traders active in multiple
+         *     blocks) but fine for ranking. `lifetime` uses the exact cumulative.
+         * @enum {string}
+         */
+        TagSortBy: "volume" | "txns" | "traders" | "fees";
+        /**
+         * @description Timeframe for `?sort=...` — defines the window the metric is summed over
+         *     (or `lifetime` for all-time cumulative).
+         * @enum {string}
+         */
+        TagSortTimeframe: "lifetime" | "1h" | "24h" | "7d" | "30d" | "1mo" | "1y";
+        /**
+         * @description Bucket row returned by both `/analytics/timeseries` (cumulative values
+         *     at end of bucket) and `/analytics/deltas` (per-bucket deltas). All metrics
+         *     the snapshot `/counts` returns are included.
+         *
          *     Short field names for compact JSON responses:
          *       t=bucket (unix seconds), v=volume_usd, bv=buy_volume_usd, sv=sell_volume_usd,
-         *       ut=unique_traders, tc=txn_count, f=fees_usd, sh=shares_volume,
-         *       yv=yes_volume_usd, nv=no_volume_usd
+         *       ut=unique_traders, tc=txn_count, bc=buy_count, sc=sell_count,
+         *       rc=redemption_count, rv=redemption_volume_usd, mc=merge_count,
+         *       sp=split_count, f=fees_usd, sh=shares_volume,
+         *       yv=yes_volume_usd, nv=no_volume_usd, yc=yes_count, nc=no_count
          */
         TimeBucketRow: {
             /** Format: int32 */
@@ -2979,6 +3017,18 @@ export interface components {
             ut: number;
             /** Format: int64 */
             tc: number;
+            /** Format: int64 */
+            bc: number;
+            /** Format: int64 */
+            sc: number;
+            /** Format: int64 */
+            rc: number;
+            /** Format: double */
+            rv: number;
+            /** Format: int64 */
+            mc: number;
+            /** Format: int64 */
+            sp: number;
             /** Format: double */
             f: number;
             /** Format: double */
@@ -2987,6 +3037,10 @@ export interface components {
             yv: number;
             /** Format: double */
             nv: number;
+            /** Format: int64 */
+            yc: number;
+            /** Format: int64 */
+            nc: number;
         };
         /** @description Token outcome (position) */
         TokenOutcome: {
@@ -5192,8 +5246,12 @@ export interface operations {
                 limit?: number;
                 /** @description Offset-based pagination (number of results to skip). Takes precedence over pagination_key. */
                 offset?: number;
-                /** @description Cursor-based pagination key */
+                /** @description Cursor-based pagination key (alphabetical mode only). */
                 pagination_key?: string;
+                /** @description Sort metric. Defaults to `volume` when only `timeframe` is set. Setting either `sort` or `timeframe` adds +2 credits. */
+                sort?: components["schemas"]["TagSortBy"];
+                /** @description Window for the sort metric. Defaults to `24h` when only `sort` is set. Setting either `sort` or `timeframe` adds +2 credits. */
+                timeframe?: components["schemas"]["TagSortTimeframe"];
             };
             header?: never;
             path?: never;
@@ -5214,7 +5272,12 @@ export interface operations {
     };
     get_tag_by_id: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Attach analytics metrics. +1 credit. */
+                include_metrics?: boolean;
+                /** @description Metrics window. Default `1d` (= `24h`). Ignored unless `include_metrics=true`. */
+                timeframe?: components["schemas"]["TagSortTimeframe"];
+            };
             header?: never;
             path: {
                 /** @description Tag ID or slug */

package/dist/types/index.d.ts

@@ -53,6 +53,8 @@ export type Event = Omit<Schemas["PolymarketEvent"], "metrics"> & {
 };
 export type PolymarketSeries = Schemas["PolymarketSeries"];
 export type Tag = Schemas["PolymarketTag"];
+export type TagSortBy = Schemas["TagSortBy"];
+export type TagSortTimeframe = Schemas["TagSortTimeframe"];
 export type UserProfile = Schemas["PolymarketUserProfile"];
 export type PositionHoldersResponse = Schemas["PositionHoldersResponse"];
 export type PositionStatus = Schemas["PositionStatus"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@structbuild/sdk",
-  "version": "0.3.10-staging.3",
+  "version": "0.3.10-staging.5",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",