pmxtjs 2.47.0 → 2.48.0

package/generated/src/models/UnifiedSeries.ts

@@ -0,0 +1,155 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { UnifiedEvent } from './UnifiedEvent';
+import {
+    UnifiedEventFromJSON,
+    UnifiedEventFromJSONTyped,
+    UnifiedEventToJSON,
+    UnifiedEventToJSONTyped,
+} from './UnifiedEvent';
+
+/**
+ * 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`.
+ * @export
+ * @interface UnifiedSeries
+ */
+export interface UnifiedSeries {
+    /**
+     * Stable venue-native series identifier (e.g. "KXATPMATCH" on Kalshi, "atp" on Polymarket Gamma, numeric Gamma id).
+     * @type {string}
+     * @memberof UnifiedSeries
+     */
+    id: string;
+    /**
+     * Venue-native ticker, when distinct from `id`.
+     * @type {string}
+     * @memberof UnifiedSeries
+     */
+    ticker?: string;
+    /**
+     * Venue-native slug.
+     * @type {string}
+     * @memberof UnifiedSeries
+     */
+    slug?: string;
+    /**
+     * Human-readable series title (e.g. "ATP Match Winner", "WTA").
+     * @type {string}
+     * @memberof UnifiedSeries
+     */
+    title: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UnifiedSeries
+     */
+    description?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UnifiedSeries
+     */
+    recurrence?: string | null;
+    /**
+     * Child events. Populated when fetched by id; the list form usually omits this to keep payloads small.
+     * @type {Array<UnifiedEvent>}
+     * @memberof UnifiedSeries
+     */
+    events?: Array<UnifiedEvent>;
+    /**
+     * 
+     * @type {string}
+     * @memberof UnifiedSeries
+     */
+    url?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UnifiedSeries
+     */
+    image?: string | null;
+    /**
+     * The exchange this series originates from. Populated by the Router.
+     * @type {string}
+     * @memberof UnifiedSeries
+     */
+    sourceExchange?: string;
+    /**
+     * Raw venue-specific fields not promoted to first-class columns.
+     * @type {{ [key: string]: any; }}
+     * @memberof UnifiedSeries
+     */
+    sourceMetadata?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the UnifiedSeries interface.
+ */
+export function instanceOfUnifiedSeries(value: object): value is UnifiedSeries {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    return true;
+}
+
+export function UnifiedSeriesFromJSON(json: any): UnifiedSeries {
+    return UnifiedSeriesFromJSONTyped(json, false);
+}
+
+export function UnifiedSeriesFromJSONTyped(json: any, ignoreDiscriminator: boolean): UnifiedSeries {
+    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'] as Array<any>).map(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'],
+    };
+}
+
+export function UnifiedSeriesToJSON(json: any): UnifiedSeries {
+    return UnifiedSeriesToJSONTyped(json, false);
+}
+
+export function UnifiedSeriesToJSONTyped(value?: UnifiedSeries | null, ignoreDiscriminator: boolean = false): any {
+    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'] as Array<any>).map(UnifiedEventToJSON)),
+        'url': value['url'],
+        'image': value['image'],
+        'sourceExchange': value['sourceExchange'],
+        'sourceMetadata': value['sourceMetadata'],
+    };
+}
+

package/generated/src/models/index.ts

@@ -60,6 +60,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';
@@ -101,4 +102,5 @@ export * from './Trade';
 export * from './TradesParams';
 export * from './UnifiedEvent';
 export * from './UnifiedMarket';
+export * from './UnifiedSeries';
 export * from './UserTrade';

package/index.ts

@@ -30,6 +30,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";
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "2.47.0",
+  "version": "2.48.0",
   "description": "Unified prediction market data API - The ccxt for prediction markets",
   "author": "PMXT Contributors",
   "repository": {
@@ -43,7 +43,7 @@
     "unified"
   ],
   "dependencies": {
-    "pmxt-core": "2.47.0",
+    "pmxt-core": "2.48.0",
     "ws": "^8.18.0"
   },
   "devDependencies": {

package/pmxt/client.ts

@@ -36,12 +36,14 @@ import {
     PaginatedMarketsResult,
     PaginatedEventsResult,
     Position,
+    SeriesFetchParams,
     PriceCandle,
     SubscribedAddressSnapshot,
     SubscriptionOption,
     Trade,
     UnifiedEvent,
     UnifiedMarket,
+    UnifiedSeries,
     UserTrade,
     FirehoseEvent,
 } from "./models.js";
@@ -172,6 +174,10 @@ function convertEvent(raw: any): UnifiedEvent {
     return { ...raw, markets };
 }
 
+function convertSeries(raw: any): UnifiedSeries {
+    const events = Array.isArray(raw.events) ? raw.events.map(convertEvent) : undefined;
+    return { ...raw, ...(events !== undefined ? { events } : {}) };
+}
 
 function convertSubscriptionSnapshot(raw: any): SubscribedAddressSnapshot {
     return {
@@ -863,6 +869,32 @@ export abstract class Exchange {
         }
     }
 
+    async fetchSeries(params?: SeriesFetchParams): Promise<UnifiedSeries[]> {
+        await this.initPromise;
+        try {
+            const args: any[] = [];
+            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 fromServerError(body.error);
+                }
+                throw new 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 PmxtError) throw error;
+            throw new PmxtError(`Failed to fetchSeries: ${error}`);
+        }
+    }
+
     async fetchMarket(params?: MarketFetchParams): Promise<UnifiedMarket> {
         await this.initPromise;
         try {

package/pmxt/models.ts

@@ -505,6 +505,25 @@ 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.
  */
@@ -660,6 +679,46 @@ export class MarketList extends Array<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)
  */