@structbuild/sdk 0.3.10-staging.2 → 0.3.10-staging.4

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. Supports both cursor-based and offset-based pagination. Pass `sort=<metric>` to order tags by a traded-volume-style metric — requires `timeframe` to pick the window.
          */
         get: operations["get_tags"];
         put?: never;
@@ -1247,6 +1247,14 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /**
+         * @description Resolution for `/analytics/timeseries` and `/analytics/deltas`.
+         *     Superset of `CandlestickResolution` — adds 7-day (`W`/`1W`) and calendar
+         *     month (`M`/`1M`) buckets, which are pre-aggregated for global and tag
+         *     domains and re-bucketed from the `_1d` MV for market/event/trader.
+         * @enum {string}
+         */
+        AnalyticsResolution: "1" | "5" | "15" | "30" | "60" | "240" | "D" | "1D" | "W" | "1W" | "M" | "1M";
         /** @description Output payload for ERC1155 setApprovalForAll events. */
         ApprovalTrade: {
             id: string;
@@ -2440,6 +2448,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: {
@@ -2951,6 +2979,20 @@ export interface components {
             /** Format: int32 */
             ask_levels?: number | null;
         };
+        /**
+         * @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 Timeseries bucket row.
          *     Short field names for compact JSON responses:
@@ -3332,7 +3374,7 @@ export interface operations {
     get_global_analytics_changes: {
         parameters: {
             query: {
-                /** @description Lookback window: 1h, 24h, 7d, 30d, 1y */
+                /** @description Lookback window: 1h, 24h, 7d, 30d, 1mo, 1y */
                 timeframe: components["schemas"]["ChangeTimeframe"];
             };
             header?: never;
@@ -3375,8 +3417,8 @@ export interface operations {
     get_global_analytics_deltas: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds). Omit for all-time. */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */
@@ -3406,8 +3448,8 @@ export interface operations {
     get_global_analytics_timeseries: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds). Omit for all-time. */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */
@@ -3729,8 +3771,8 @@ export interface operations {
     get_event_analytics_deltas: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds) */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */
@@ -3763,8 +3805,8 @@ export interface operations {
     get_event_analytics_timeseries: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds) */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */
@@ -4694,8 +4736,8 @@ export interface operations {
     get_market_analytics_deltas: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds) */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */
@@ -4728,8 +4770,8 @@ export interface operations {
     get_market_analytics_timeseries: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds) */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */
@@ -5184,8 +5226,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 (offset-paginated). Omit for default alphabetical listing. */
+                sort?: components["schemas"]["TagSortBy"];
+                /** @description Window for the sort metric. Required when `sort` is set. */
+                timeframe?: components["schemas"]["TagSortTimeframe"];
             };
             header?: never;
             path?: never;
@@ -5263,8 +5309,8 @@ export interface operations {
     get_tag_analytics_deltas: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds) */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */
@@ -5297,8 +5343,8 @@ export interface operations {
     get_tag_analytics_timeseries: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds) */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */
@@ -5792,8 +5838,8 @@ export interface operations {
     get_trader_analytics_deltas: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds) */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */
@@ -5826,8 +5872,8 @@ export interface operations {
     get_trader_analytics_timeseries: {
         parameters: {
             query?: {
-                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D (default: 60) */
-                resolution?: components["schemas"]["CandlestickResolution"];
+                /** @description Bucket size: 1, 5, 15, 30, 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
+                resolution?: components["schemas"]["AnalyticsResolution"];
                 /** @description Start timestamp (Unix seconds) */
                 from?: number;
                 /** @description End timestamp (Unix seconds) */

package/dist/types/index.d.ts

@@ -9,6 +9,7 @@ import type { Schemas, OperationQuery } from "./helpers.js";
 import type { WebhookSchemas, WebhookOperationQuery, WebhookOperationRequestBody } from "./webhook-helpers.js";
 type TimeframeKey = Schemas["MetricsTimeframe"];
 type TimeframeRecord<V> = Partial<Record<TimeframeKey, V>>;
+export type AnalyticsResolution = Schemas["AnalyticsResolution"];
 export type BondMarket = Schemas["BondMarket"];
 export type BondOutcome = Schemas["BondOutcome"];
 export type BondsSortBy = Schemas["BondsSortBy"];
@@ -52,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.2",
+  "version": "0.3.10-staging.4",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",