pmxtjs 2.46.14 → 2.48.0

package/dist/generated/src/models/UnifiedSeries.js

@@ -0,0 +1,73 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi, Limitless). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation.
+ *
+ * The version of the OpenAPI document: 0.4.4
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUnifiedSeries = instanceOfUnifiedSeries;
+exports.UnifiedSeriesFromJSON = UnifiedSeriesFromJSON;
+exports.UnifiedSeriesFromJSONTyped = UnifiedSeriesFromJSONTyped;
+exports.UnifiedSeriesToJSON = UnifiedSeriesToJSON;
+exports.UnifiedSeriesToJSONTyped = UnifiedSeriesToJSONTyped;
+const UnifiedEvent_1 = require("./UnifiedEvent");
+/**
+ * Check if a given object implements the UnifiedSeries interface.
+ */
+function instanceOfUnifiedSeries(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    return true;
+}
+function UnifiedSeriesFromJSON(json) {
+    return UnifiedSeriesFromJSONTyped(json, false);
+}
+function UnifiedSeriesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'ticker': json['ticker'] == null ? undefined : json['ticker'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        'title': json['title'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'recurrence': json['recurrence'] == null ? undefined : json['recurrence'],
+        'events': json['events'] == null ? undefined : (json['events'].map(UnifiedEvent_1.UnifiedEventFromJSON)),
+        'url': json['url'] == null ? undefined : json['url'],
+        'image': json['image'] == null ? undefined : json['image'],
+        'sourceExchange': json['sourceExchange'] == null ? undefined : json['sourceExchange'],
+        'sourceMetadata': json['sourceMetadata'] == null ? undefined : json['sourceMetadata'],
+    };
+}
+function UnifiedSeriesToJSON(json) {
+    return UnifiedSeriesToJSONTyped(json, false);
+}
+function UnifiedSeriesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'ticker': value['ticker'],
+        'slug': value['slug'],
+        'title': value['title'],
+        'description': value['description'],
+        'recurrence': value['recurrence'],
+        'events': value['events'] == null ? undefined : (value['events'].map(UnifiedEvent_1.UnifiedEventToJSON)),
+        'url': value['url'],
+        'image': value['image'],
+        'sourceExchange': value['sourceExchange'],
+        'sourceMetadata': value['sourceMetadata'],
+    };
+}

package/dist/generated/src/models/index.d.ts

@@ -58,6 +58,7 @@ export * from './FetchOrderBookParams';
 export * from './FetchOrderBooks200Response';
 export * from './FetchOrderBooksRequest';
 export * from './FetchPositions200Response';
+export * from './FetchSeries200Response';
 export * from './FetchTrades200Response';
 export * from './FilterEventsRequest';
 export * from './FilterEventsRequestArgsInner';
@@ -99,4 +100,5 @@ export * from './Trade';
 export * from './TradesParams';
 export * from './UnifiedEvent';
 export * from './UnifiedMarket';
+export * from './UnifiedSeries';
 export * from './UserTrade';

package/dist/generated/src/models/index.js

@@ -76,6 +76,7 @@ __exportStar(require("./FetchOrderBookParams"), exports);
 __exportStar(require("./FetchOrderBooks200Response"), exports);
 __exportStar(require("./FetchOrderBooksRequest"), exports);
 __exportStar(require("./FetchPositions200Response"), exports);
+__exportStar(require("./FetchSeries200Response"), exports);
 __exportStar(require("./FetchTrades200Response"), exports);
 __exportStar(require("./FilterEventsRequest"), exports);
 __exportStar(require("./FilterEventsRequestArgsInner"), exports);
@@ -117,4 +118,5 @@ __exportStar(require("./Trade"), exports);
 __exportStar(require("./TradesParams"), exports);
 __exportStar(require("./UnifiedEvent"), exports);
 __exportStar(require("./UnifiedMarket"), exports);
+__exportStar(require("./UnifiedSeries"), exports);
 __exportStar(require("./UserTrade"), exports);

package/dist/index.d.ts

@@ -27,6 +27,7 @@ export { Router } from "./pmxt/router.js";
 export { ServerManager } from "./pmxt/server-manager.js";
 export { HOSTED_URL, LOCAL_URL, ENV, resolvePmxtBaseUrl } from "./pmxt/constants.js";
 export { MarketList } from "./pmxt/models.js";
+export type { UnifiedSeries } from "./pmxt/models.js";
 export type * from "./pmxt/models.js";
 export * from "./pmxt/errors.js";
 declare function stopServer(): Promise<void>;

package/dist/pmxt/client.d.ts

@@ -5,7 +5,7 @@
  * OpenAPI client, matching the Python API exactly.
  */
 import { Configuration, DefaultApi, ExchangeCredentials } from "../generated/src/index.js";
-import { Balance, BuiltOrder, CreateOrderParams, EventFetchParams, EventFilterCriteria, EventFilterFunction, ExecutionPriceResult, FetchOrderBookParams, MarketFetchParams, MarketFilterCriteria, MarketFilterFunction, MarketOutcome, MyTradesParams, Order, OrderBook, OrderHistoryParams, PaginatedMarketsResult, Position, PriceCandle, SubscribedAddressSnapshot, SubscriptionOption, Trade, UnifiedEvent, UnifiedMarket, UserTrade, FirehoseEvent } from "./models.js";
+import { Balance, BuiltOrder, CreateOrderParams, EventFetchParams, EventFilterCriteria, EventFilterFunction, ExecutionPriceResult, FetchOrderBookParams, MarketFetchParams, MarketFilterCriteria, MarketFilterFunction, MarketOutcome, MyTradesParams, Order, OrderBook, OrderHistoryParams, PaginatedMarketsResult, Position, SeriesFetchParams, PriceCandle, SubscribedAddressSnapshot, SubscriptionOption, Trade, UnifiedEvent, UnifiedMarket, UnifiedSeries, UserTrade, FirehoseEvent } from "./models.js";
 import { ServerManager } from "./server-manager.js";
 /**
  * Base exchange client options.
@@ -178,6 +178,7 @@ export declare abstract class Exchange {
     fetchMarkets(params?: MarketFetchParams): Promise<UnifiedMarket[]>;
     fetchMarketsPaginated(params?: any): Promise<PaginatedMarketsResult>;
     fetchEvents(params?: EventFetchParams): Promise<UnifiedEvent[]>;
+    fetchSeries(params?: SeriesFetchParams): Promise<UnifiedSeries[]>;
     fetchMarket(params?: MarketFetchParams): Promise<UnifiedMarket>;
     fetchEvent(params?: EventFetchParams): Promise<UnifiedEvent>;
     fetchOrderBook(outcomeId: string | MarketOutcome, limit?: number, params?: FetchOrderBookParams): Promise<OrderBook | OrderBook[]>;

package/dist/pmxt/client.js

@@ -114,6 +114,10 @@ function convertEvent(raw) {
     const markets = models_js_1.MarketList.from((raw.markets || []).map(convertMarket));
     return { ...raw, markets };
 }
+function convertSeries(raw) {
+    const events = Array.isArray(raw.events) ? raw.events.map(convertEvent) : undefined;
+    return { ...raw, ...(events !== undefined ? { events } : {}) };
+}
 function convertSubscriptionSnapshot(raw) {
     return {
         ...raw,
@@ -695,6 +699,34 @@ class Exchange {
             throw new errors_js_1.PmxtError(`Failed to fetchEvents: ${error}`);
         }
     }
+    async fetchSeries(params) {
+        await this.initPromise;
+        try {
+            const args = [];
+            if (params !== undefined)
+                args.push(params);
+            const response = await this.fetchWithRetry(`${this.resolveBaseUrl()}/api/${this.exchangeName}/fetchSeries`, {
+                method: 'POST',
+                headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
+                body: JSON.stringify({ args, credentials: this.getCredentials() }),
+            });
+            if (!response.ok) {
+                const body = await response.json().catch(() => ({}));
+                if (body.error && typeof body.error === "object") {
+                    throw (0, errors_js_1.fromServerError)(body.error);
+                }
+                throw new errors_js_1.PmxtError(body.error?.message || response.statusText);
+            }
+            const json = await response.json();
+            const data = this.handleResponse(json);
+            return data.map(convertSeries);
+        }
+        catch (error) {
+            if (error instanceof errors_js_1.PmxtError)
+                throw error;
+            throw new errors_js_1.PmxtError(`Failed to fetchSeries: ${error}`);
+        }
+    }
     async fetchMarket(params) {
         await this.initPromise;
         try {
@@ -1070,28 +1102,25 @@ class Exchange {
     }
     async unwatchOrderBook(outcomeId) {
         await this.initPromise;
-        const resolvedOutcomeId = resolveOutcomeId(outcomeId);
-        const args = [resolvedOutcomeId];
         try {
-            const ws = await this.getOrCreateWs();
-            if (!ws) {
-                throw this.wsTransportUnavailableError("unwatchOrderBook");
-            }
-            const requestId = this.getWsSubscriptionId(ws, "watchOrderBook", args)
-                ?? `req-${Math.random().toString(36).slice(2, 14)}`;
-            await this.sendWsMessage(ws, {
-                id: requestId,
-                action: "unsubscribe",
-                exchange: this.exchangeName,
-                method: "unwatchOrderBook",
-                args,
+            const args = [];
+            args.push(resolveOutcomeId(outcomeId));
+            const response = await this.fetchWithRetry(`${this.resolveBaseUrl()}/api/${this.exchangeName}/unwatchOrderBook`, {
+                method: 'POST',
+                headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
+                body: JSON.stringify({ args, credentials: this.getCredentials() }),
             });
-            this.clearWsSubscription(ws, "watchOrderBook", args);
+            if (!response.ok) {
+                const body = await response.json().catch(() => ({}));
+                if (body.error && typeof body.error === "object") {
+                    throw (0, errors_js_1.fromServerError)(body.error);
+                }
+                throw new errors_js_1.PmxtError(body.error?.message || response.statusText);
+            }
+            const json = await response.json();
+            this.handleResponse(json);
         }
         catch (error) {
-            if (this.isWsTransportUnavailableError(error)) {
-                throw this.wsTransportUnavailableError("unwatchOrderBook");
-            }
             if (error instanceof errors_js_1.PmxtError)
                 throw error;
             throw new errors_js_1.PmxtError(`Failed to unwatchOrderBook: ${error}`);

package/dist/pmxt/models.d.ts

@@ -371,6 +371,24 @@ export interface CreateOrderParams {
 }
 /** Alias matching the core MarketFetchParams name. */
 export type MarketFetchParams = MarketFilterParams;
+/**
+ * Parameters for fetching series.
+ * Venues without a recurring-event concept return an empty array regardless of the filters.
+ */
+export interface SeriesFetchParams {
+    /** Direct lookup by venue-native series id (e.g. "KXATPMATCH" on Kalshi, "atp" on Polymarket Gamma). When set, the result includes events where the venue supports it. */
+    id?: string;
+    /** Lookup by series slug (e.g. "wta", "nfl"). */
+    slug?: string;
+    /** Keyword search across series title / description. */
+    query?: string;
+    /** Filter by recurrence cadence ('daily', 'weekly', 'annual', ...). */
+    recurrence?: string;
+    /** Maximum number of results to return. */
+    limit?: number;
+    /** Pagination offset. */
+    offset?: number;
+}
 /**
  * Parameters for fetching OHLCV candle data.
  */
@@ -475,6 +493,35 @@ export declare class MarketList extends Array<UnifiedMarket> {
      */
     match(query: string, searchIn?: ('title' | 'description' | 'category' | 'tags' | 'outcomes')[]): UnifiedMarket;
 }
+/**
+ * A recurring grouping of events on a venue — the tier above Event.
+ * Examples: Kalshi "KXATPMATCH" (every ATP match), Polymarket "wta" (every WTA match).
+ * Venues without a recurring-event concept return an empty array from fetchSeries.
+ */
+export interface UnifiedSeries {
+    /** Stable venue-native series identifier. */
+    id: string;
+    /** Venue-native ticker, when distinct from id. */
+    ticker?: string;
+    /** Venue-native slug. */
+    slug?: string;
+    /** Human-readable series title. */
+    title: string;
+    /** Long-form series description. */
+    description?: string | null;
+    /** Recurrence cadence the venue reports ('daily', 'weekly', 'annual', ...). */
+    recurrence?: string | null;
+    /** Child events. Populated when fetched by id; the list form usually omits this. */
+    events?: UnifiedEvent[];
+    /** Canonical venue URL for the series. */
+    url?: string | null;
+    /** Venue-hosted image. */
+    image?: string | null;
+    /** The exchange this series originates from. Populated by the Router. */
+    sourceExchange?: string;
+    /** Raw venue-specific fields not promoted to first-class columns. */
+    sourceMetadata?: Record<string, unknown>;
+}
 /**
  * A grouped collection of related markets (e.g., "Who will be Fed Chair?" contains multiple candidate markets)
  */

package/generated/.openapi-generator/FILES

@@ -64,6 +64,7 @@ docs/FetchOrderBookParams.md
 docs/FetchOrderBooks200Response.md
 docs/FetchOrderBooksRequest.md
 docs/FetchPositions200Response.md
+docs/FetchSeries200Response.md
 docs/FetchTrades200Response.md
 docs/FilterEventsRequest.md
 docs/FilterEventsRequestArgsInner.md
@@ -105,6 +106,7 @@ docs/Trade.md
 docs/TradesParams.md
 docs/UnifiedEvent.md
 docs/UnifiedMarket.md
+docs/UnifiedSeries.md
 docs/UserTrade.md
 package.json
 src/apis/DataFeedsApi.ts
@@ -171,6 +173,7 @@ src/models/FetchOrderBookParams.ts
 src/models/FetchOrderBooks200Response.ts
 src/models/FetchOrderBooksRequest.ts
 src/models/FetchPositions200Response.ts
+src/models/FetchSeries200Response.ts
 src/models/FetchTrades200Response.ts
 src/models/FilterEventsRequest.ts
 src/models/FilterEventsRequestArgsInner.ts
@@ -212,6 +215,7 @@ src/models/Trade.ts
 src/models/TradesParams.ts
 src/models/UnifiedEvent.ts
 src/models/UnifiedMarket.ts
+src/models/UnifiedSeries.ts
 src/models/UserTrade.ts
 src/models/index.ts
 src/runtime.ts

package/generated/docs/DefaultApi.md

@@ -32,6 +32,7 @@ All URIs are relative to *http://localhost:3847*
 | [**fetchOrderBooks**](DefaultApi.md#fetchorderbooksoperation) | **POST** /api/{exchange}/fetchOrderBooks | Fetch Order Books |
 | [**fetchPositions**](DefaultApi.md#fetchpositions) | **GET** /api/{exchange}/fetchPositions | Fetch Positions |
 | [**fetchRelatedMarkets**](DefaultApi.md#fetchrelatedmarkets) | **GET** /api/{exchange}/fetchRelatedMarkets | Find Related Markets |
+| [**fetchSeries**](DefaultApi.md#fetchseries) | **GET** /api/{exchange}/fetchSeries | Fetch Series |
 | [**fetchTrades**](DefaultApi.md#fetchtrades) | **GET** /api/{exchange}/fetchTrades | Fetch Trades |
 | [**filterEvents**](DefaultApi.md#filtereventsoperation) | **POST** /api/{exchange}/filterEvents | Filter Events |
 | [**filterMarkets**](DefaultApi.md#filtermarketsoperation) | **POST** /api/{exchange}/filterMarkets | Filter Markets |
@@ -702,7 +703,7 @@ No authorization required
 
 ## fetchEvent
 
-> FetchEvent200Response fetchEvent(exchange, query, limit, cursor, offset, sort, status, searchIn, eventId, slug, filter, category, tags)
+> FetchEvent200Response fetchEvent(exchange, query, limit, cursor, offset, sort, status, searchIn, eventId, slug, series, filter, category, tags)
 
 Fetch Event
 
@@ -742,6 +743,8 @@ async function example() {
     eventId: eventId_example,
     // string | Lookup by event slug (optional)
     slug: slug_example,
+    // string | Filter events by their parent series. Accepts the venue-native series id / ticker / slug (e.g. Kalshi `\"KXATPMATCH\"`, Polymarket `\"wta\"`). Passed through to the vendor where supported, otherwise applied to `sourceMetadata` after fetch. (optional)
+    series: series_example,
     // EventFilterCriteria | Optional client-side filter applied after fetching (optional)
     filter: ...,
     // string | Filter by category. Each event belongs to a venue-assigned category such as \"Sports\", \"Politics\", \"Crypto\", \"Bitcoin\", \"Soccer\", \"Economic Policy\" (Polymarket) or \"Sports\", \"Mentions\" (Kalshi). (optional)
@@ -777,6 +780,7 @@ example().catch(console.error);
 | **searchIn** | `title`, `description`, `both` | Where to search (default: \'title\') | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
 | **eventId** | `string` | Direct lookup by event ID | [Optional] [Defaults to `undefined`] |
 | **slug** | `string` | Lookup by event slug | [Optional] [Defaults to `undefined`] |
+| **series** | `string` | Filter events by their parent series. Accepts the venue-native series id / ticker / slug (e.g. Kalshi `\"KXATPMATCH\"`, Polymarket `\"wta\"`). Passed through to the vendor where supported, otherwise applied to `sourceMetadata` after fetch. | [Optional] [Defaults to `undefined`] |
 | **filter** | [](.md) | Optional client-side filter applied after fetching | [Optional] [Defaults to `undefined`] |
 | **category** | `string` | Filter by category. Each event belongs to a venue-assigned category such as \"Sports\", \"Politics\", \"Crypto\", \"Bitcoin\", \"Soccer\", \"Economic Policy\" (Polymarket) or \"Sports\", \"Mentions\" (Kalshi). | [Optional] [Defaults to `undefined`] |
 | **tags** | `Array<string>` | Filter by tags. Returns events matching ANY of the provided tags. Tags are more specific than categories -- for example a \&quot;Politics\&quot; event might carry tags [\&quot;Politics\&quot;, \&quot;Geopolitics\&quot;, \&quot;Middle East\&quot;, \&quot;Iran\&quot;]. Common tags include \&quot;Crypto\&quot;, \&quot;Elections\&quot;, \&quot;Fed Rates\&quot;, \&quot;FIFA World Cup\&quot;, \&quot;Trump\&quot;. | [Optional] |
@@ -899,7 +903,7 @@ No authorization required
 
 ## fetchEvents
 
-> FetchEvents200Response fetchEvents(exchange, query, limit, cursor, offset, sort, status, searchIn, eventId, slug, filter, category, tags)
+> FetchEvents200Response fetchEvents(exchange, query, limit, cursor, offset, sort, status, searchIn, eventId, slug, series, filter, category, tags)
 
 Fetch Events
 
@@ -939,6 +943,8 @@ async function example() {
     eventId: eventId_example,
     // string | Lookup by event slug (optional)
     slug: slug_example,
+    // string | Filter events by their parent series. Accepts the venue-native series id / ticker / slug (e.g. Kalshi `\"KXATPMATCH\"`, Polymarket `\"wta\"`). Passed through to the vendor where supported, otherwise applied to `sourceMetadata` after fetch. (optional)
+    series: series_example,
     // EventFilterCriteria | Optional client-side filter applied after fetching (optional)
     filter: ...,
     // string | Filter by category. Each event belongs to a venue-assigned category such as \"Sports\", \"Politics\", \"Crypto\", \"Bitcoin\", \"Soccer\", \"Economic Policy\" (Polymarket) or \"Sports\", \"Mentions\" (Kalshi). (optional)
@@ -974,6 +980,7 @@ example().catch(console.error);
 | **searchIn** | `title`, `description`, `both` | Where to search (default: \&#39;title\&#39;) | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
 | **eventId** | `string` | Direct lookup by event ID | [Optional] [Defaults to `undefined`] |
 | **slug** | `string` | Lookup by event slug | [Optional] [Defaults to `undefined`] |
+| **series** | `string` | Filter events by their parent series. Accepts the venue-native series id / ticker / slug (e.g. Kalshi &#x60;\&quot;KXATPMATCH\&quot;&#x60;, Polymarket &#x60;\&quot;wta\&quot;&#x60;). Passed through to the vendor where supported, otherwise applied to &#x60;sourceMetadata&#x60; after fetch. | [Optional] [Defaults to `undefined`] |
 | **filter** | [](.md) | Optional client-side filter applied after fetching | [Optional] [Defaults to `undefined`] |
 | **category** | `string` | Filter by category. Each event belongs to a venue-assigned category such as \&quot;Sports\&quot;, \&quot;Politics\&quot;, \&quot;Crypto\&quot;, \&quot;Bitcoin\&quot;, \&quot;Soccer\&quot;, \&quot;Economic Policy\&quot; (Polymarket) or \&quot;Sports\&quot;, \&quot;Mentions\&quot; (Kalshi). | [Optional] [Defaults to `undefined`] |
 | **tags** | `Array<string>` | Filter by tags. Returns events matching ANY of the provided tags. Tags are more specific than categories -- for example a \&quot;Politics\&quot; event might carry tags [\&quot;Politics\&quot;, \&quot;Geopolitics\&quot;, \&quot;Middle East\&quot;, \&quot;Iran\&quot;]. Common tags include \&quot;Crypto\&quot;, \&quot;Elections\&quot;, \&quot;Fed Rates\&quot;, \&quot;FIFA World Cup\&quot;, \&quot;Trump\&quot;. | [Optional] |
@@ -2349,6 +2356,73 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## fetchSeries
+
+> FetchSeries200Response fetchSeries(exchange)
+
+Fetch Series
+
+Fetch the recurring series (fourth tier above Event -&gt; Market -&gt; Outcome) that this venue exposes. Returns an empty array on venues without a series concept (Limitless, Smarkets, Probable, Metaculus, Baozi, Hyperliquid, SuiBets, Polymarket US). - &#x60;params.id&#x60; -&gt; a single matching series with its events populated where supported. - no params -&gt; the full list, typically without nested events for payload size.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from 'pmxtjs';
+import type { FetchSeriesRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | 'gemini-titan' | 'hyperliquid' | 'suibets' | 'mock' | 'router' | The prediction market exchange to target.
+    exchange: exchange_example,
+  } satisfies FetchSeriesRequest;
+
+  try {
+    const data = await api.fetchSeries(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us`, `gemini-titan`, `hyperliquid`, `suibets`, `mock`, `router` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, gemini-titan, hyperliquid, suibets, mock, router] |
+
+### Return type
+
+[**FetchSeries200Response**](FetchSeries200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Fetch Series response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## fetchTrades
 
 > FetchTrades200Response fetchTrades(exchange, outcomeId, start, end, limit)

package/generated/docs/EventFetchParams.md

@@ -15,6 +15,7 @@ Name | Type
 `searchIn` | string
 `eventId` | string
 `slug` | string
+`series` | string
 `filter` | [EventFilterCriteria](EventFilterCriteria.md)
 `category` | string
 `tags` | Array<string>
@@ -35,6 +36,7 @@ const example = {
   "searchIn": null,
   "eventId": null,
   "slug": null,
+  "series": null,
   "filter": null,
   "category": null,
   "tags": null,

package/generated/docs/FetchSeries200Response.md

@@ -0,0 +1,38 @@
+
+# FetchSeries200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | [ErrorDetail](ErrorDetail.md)
+`data` | [Array<UnifiedSeries>](UnifiedSeries.md)
+
+## Example
+
+```typescript
+import type { FetchSeries200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": true,
+  "error": null,
+  "data": null,
+} satisfies FetchSeries200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchSeries200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/UnifiedEvent.md

@@ -18,6 +18,7 @@ Name | Type
 `image` | string
 `category` | string
 `tags` | Array<string>
+`sourceMetadata` | { [key: string]: any; }
 `sourceExchange` | string
 
 ## Example
@@ -38,6 +39,7 @@ const example = {
   "image": null,
   "category": null,
   "tags": null,
+  "sourceMetadata": null,
   "sourceExchange": null,
 } satisfies UnifiedEvent
 

package/generated/docs/UnifiedMarket.md

@@ -24,6 +24,7 @@ Name | Type
 `tickSize` | number
 `status` | string
 `contractAddress` | string
+`sourceMetadata` | { [key: string]: any; }
 `sourceExchange` | string
 `yes` | [MarketOutcome](MarketOutcome.md)
 `no` | [MarketOutcome](MarketOutcome.md)
@@ -55,6 +56,7 @@ const example = {
   "tickSize": null,
   "status": null,
   "contractAddress": null,
+  "sourceMetadata": null,
   "sourceExchange": null,
   "yes": null,
   "no": null,

package/generated/docs/UnifiedSeries.md

@@ -0,0 +1,55 @@
+
+# UnifiedSeries
+
+A recurring grouping of events on a venue — the fourth tier above Event -> Market -> Outcome. Examples: Kalshi `KXATPMATCH` (every ATP tennis match), Polymarket `wta` (every WTA match), Opinion\'s daily `collection`. Series only exists where the venue exposes a recurring-event concept; venues without one return an empty array from `fetchSeries`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`ticker` | string
+`slug` | string
+`title` | string
+`description` | string
+`recurrence` | string
+`events` | [Array<UnifiedEvent>](UnifiedEvent.md)
+`url` | string
+`image` | string
+`sourceExchange` | string
+`sourceMetadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { UnifiedSeries } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "ticker": null,
+  "slug": null,
+  "title": null,
+  "description": null,
+  "recurrence": null,
+  "events": null,
+  "url": null,
+  "image": null,
+  "sourceExchange": null,
+  "sourceMetadata": null,
+} satisfies UnifiedSeries
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UnifiedSeries
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "2.46.14",
+  "version": "2.48.0",
   "description": "OpenAPI client for pmxtjs",
   "author": "OpenAPI-Generator",
   "repository": {