pmxtjs 1.3.3 → 1.4.0

package/generated/src/models/GetExecutionPriceDetailed200Response.ts

@@ -0,0 +1,96 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi). 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 { ErrorDetail } from './ErrorDetail';
+import {
+    ErrorDetailFromJSON,
+    ErrorDetailFromJSONTyped,
+    ErrorDetailToJSON,
+    ErrorDetailToJSONTyped,
+} from './ErrorDetail';
+import type { ExecutionPriceResult } from './ExecutionPriceResult';
+import {
+    ExecutionPriceResultFromJSON,
+    ExecutionPriceResultFromJSONTyped,
+    ExecutionPriceResultToJSON,
+    ExecutionPriceResultToJSONTyped,
+} from './ExecutionPriceResult';
+
+/**
+ * 
+ * @export
+ * @interface GetExecutionPriceDetailed200Response
+ */
+export interface GetExecutionPriceDetailed200Response {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetExecutionPriceDetailed200Response
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {ErrorDetail}
+     * @memberof GetExecutionPriceDetailed200Response
+     */
+    error?: ErrorDetail;
+    /**
+     * 
+     * @type {ExecutionPriceResult}
+     * @memberof GetExecutionPriceDetailed200Response
+     */
+    data?: ExecutionPriceResult;
+}
+
+/**
+ * Check if a given object implements the GetExecutionPriceDetailed200Response interface.
+ */
+export function instanceOfGetExecutionPriceDetailed200Response(value: object): value is GetExecutionPriceDetailed200Response {
+    return true;
+}
+
+export function GetExecutionPriceDetailed200ResponseFromJSON(json: any): GetExecutionPriceDetailed200Response {
+    return GetExecutionPriceDetailed200ResponseFromJSONTyped(json, false);
+}
+
+export function GetExecutionPriceDetailed200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetExecutionPriceDetailed200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'] == null ? undefined : json['success'],
+        'error': json['error'] == null ? undefined : ErrorDetailFromJSON(json['error']),
+        'data': json['data'] == null ? undefined : ExecutionPriceResultFromJSON(json['data']),
+    };
+}
+
+export function GetExecutionPriceDetailed200ResponseToJSON(json: any): GetExecutionPriceDetailed200Response {
+    return GetExecutionPriceDetailed200ResponseToJSONTyped(json, false);
+}
+
+export function GetExecutionPriceDetailed200ResponseToJSONTyped(value?: GetExecutionPriceDetailed200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': ErrorDetailToJSON(value['error']),
+        'data': ExecutionPriceResultToJSON(value['data']),
+    };
+}
+

package/generated/src/models/GetExecutionPriceRequest.ts

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi). 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 { GetExecutionPriceRequestArgsInner } from './GetExecutionPriceRequestArgsInner';
+import {
+    GetExecutionPriceRequestArgsInnerFromJSON,
+    GetExecutionPriceRequestArgsInnerFromJSONTyped,
+    GetExecutionPriceRequestArgsInnerToJSON,
+    GetExecutionPriceRequestArgsInnerToJSONTyped,
+} from './GetExecutionPriceRequestArgsInner';
+import type { ExchangeCredentials } from './ExchangeCredentials';
+import {
+    ExchangeCredentialsFromJSON,
+    ExchangeCredentialsFromJSONTyped,
+    ExchangeCredentialsToJSON,
+    ExchangeCredentialsToJSONTyped,
+} from './ExchangeCredentials';
+
+/**
+ * 
+ * @export
+ * @interface GetExecutionPriceRequest
+ */
+export interface GetExecutionPriceRequest {
+    /**
+     * [orderBook, side, amount]
+     * @type {Array<GetExecutionPriceRequestArgsInner>}
+     * @memberof GetExecutionPriceRequest
+     */
+    args: Array<GetExecutionPriceRequestArgsInner>;
+    /**
+     * 
+     * @type {ExchangeCredentials}
+     * @memberof GetExecutionPriceRequest
+     */
+    credentials?: ExchangeCredentials;
+}
+
+/**
+ * Check if a given object implements the GetExecutionPriceRequest interface.
+ */
+export function instanceOfGetExecutionPriceRequest(value: object): value is GetExecutionPriceRequest {
+    if (!('args' in value) || value['args'] === undefined) return false;
+    return true;
+}
+
+export function GetExecutionPriceRequestFromJSON(json: any): GetExecutionPriceRequest {
+    return GetExecutionPriceRequestFromJSONTyped(json, false);
+}
+
+export function GetExecutionPriceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetExecutionPriceRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'args': ((json['args'] as Array<any>).map(GetExecutionPriceRequestArgsInnerFromJSON)),
+        'credentials': json['credentials'] == null ? undefined : ExchangeCredentialsFromJSON(json['credentials']),
+    };
+}
+
+export function GetExecutionPriceRequestToJSON(json: any): GetExecutionPriceRequest {
+    return GetExecutionPriceRequestToJSONTyped(json, false);
+}
+
+export function GetExecutionPriceRequestToJSONTyped(value?: GetExecutionPriceRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'args': ((value['args'] as Array<any>).map(GetExecutionPriceRequestArgsInnerToJSON)),
+        'credentials': ExchangeCredentialsToJSON(value['credentials']),
+    };
+}
+

package/generated/src/models/GetExecutionPriceRequestArgsInner.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi). 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 type { OrderBook } from './OrderBook';
+import {
+    instanceOfOrderBook,
+    OrderBookFromJSON,
+    OrderBookFromJSONTyped,
+    OrderBookToJSON,
+} from './OrderBook';
+
+/**
+ * @type GetExecutionPriceRequestArgsInner
+ * 
+ * @export
+ */
+export type GetExecutionPriceRequestArgsInner = OrderBook | number | string;
+
+export function GetExecutionPriceRequestArgsInnerFromJSON(json: any): GetExecutionPriceRequestArgsInner {
+    return GetExecutionPriceRequestArgsInnerFromJSONTyped(json, false);
+}
+
+export function GetExecutionPriceRequestArgsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetExecutionPriceRequestArgsInner {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json !== 'object') {
+        return json;
+    }
+    if (instanceOfOrderBook(json)) {
+        return OrderBookFromJSONTyped(json, true);
+    }
+    if (typeof json === 'number') {
+        return json;
+    }
+    if (typeof json === 'string' && (json === 'buy' || json === 'sell')) {
+        return json;
+    }
+    return {} as any;
+}
+
+export function GetExecutionPriceRequestArgsInnerToJSON(json: any): any {
+    return GetExecutionPriceRequestArgsInnerToJSONTyped(json, false);
+}
+
+export function GetExecutionPriceRequestArgsInnerToJSONTyped(value?: GetExecutionPriceRequestArgsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value !== 'object') {
+        return value;
+    }
+    if (instanceOfOrderBook(value)) {
+        return OrderBookToJSON(value as OrderBook);
+    }
+    if (typeof value === 'number') {
+        return value;
+    }
+    if (typeof value === 'string' && (value === 'buy' || value === 'sell')) {
+        return value;
+    }
+    return {};
+}
+

package/generated/src/models/index.ts

@@ -10,6 +10,7 @@ export * from './CreateOrderRequest';
 export * from './ErrorDetail';
 export * from './ErrorResponse';
 export * from './ExchangeCredentials';
+export * from './ExecutionPriceResult';
 export * from './FetchBalance200Response';
 export * from './FetchMarkets200Response';
 export * from './FetchMarketsRequest';
@@ -24,6 +25,10 @@ export * from './FetchPositions200Response';
 export * from './FetchPositionsRequest';
 export * from './FetchTrades200Response';
 export * from './FetchTradesRequest';
+export * from './GetExecutionPrice200Response';
+export * from './GetExecutionPriceDetailed200Response';
+export * from './GetExecutionPriceRequest';
+export * from './GetExecutionPriceRequestArgsInner';
 export * from './GetMarketsBySlugRequest';
 export * from './HealthCheck200Response';
 export * from './HistoryFilterParams';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "1.3.3",
+  "version": "1.4.0",
   "description": "Unified prediction market data API - The ccxt for prediction markets",
   "author": "PMXT Contributors",
   "repository": {
@@ -42,7 +42,7 @@
     "unified"
   ],
   "dependencies": {
-    "pmxt-core": "1.3.3"
+    "pmxt-core": "1.4.0"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",

package/pmxt/client.ts

@@ -34,6 +34,9 @@ import {
     MarketFilterParams,
     HistoryFilterParams,
     CreateOrderParams,
+    SearchIn,
+    UnifiedEvent,
+    ExecutionPriceResult,
 } from "./models.js";
 
 import { ServerManager } from "./server-manager.js";
@@ -156,6 +159,39 @@ function convertBalance(raw: any): Balance {
     };
 }
 
+function convertEvent(raw: any): UnifiedEvent {
+    const markets = (raw.markets || []).map(convertMarket);
+
+    return {
+        id: raw.id,
+        title: raw.title,
+        description: raw.description,
+        slug: raw.slug,
+        markets,
+        url: raw.url,
+        image: raw.image,
+        category: raw.category,
+        tags: raw.tags,
+        searchMarkets(query: string, searchIn: SearchIn = "both"): UnifiedMarket[] {
+            const queryLower = query.toLowerCase();
+            return this.markets.filter(market => {
+                let match = false;
+                if (searchIn === "title" || searchIn === "both") {
+                    if (market.title.toLowerCase().includes(queryLower)) {
+                        match = true;
+                    }
+                }
+                if (searchIn === "description" || searchIn === "both") {
+                    if (market.description?.toLowerCase().includes(queryLower)) {
+                        match = true;
+                    }
+                }
+                return match;
+            });
+        }
+    };
+}
+
 /**
  * Base exchange client options.
  */
@@ -184,6 +220,7 @@ export abstract class Exchange {
     protected apiKey?: string;
     protected privateKey?: string;
     protected api: DefaultApi;
+    protected config: Configuration;
     protected serverManager: ServerManager;
     protected initPromise: Promise<void>;
 
@@ -199,8 +236,8 @@ export abstract class Exchange {
         this.serverManager = new ServerManager({ baseUrl });
 
         // Configure the API client with the initial base URL (will be updated if port changes)
-        const config = new Configuration({ basePath: baseUrl });
-        this.api = new DefaultApi(config);
+        this.config = new Configuration({ basePath: baseUrl });
+        this.api = new DefaultApi(this.config);
 
         // Initialize the server connection asynchronously
         this.initPromise = this.initializeServer(autoStartServer);
@@ -223,11 +260,11 @@ export abstract class Exchange {
                 }
 
                 // Update API client with actual base URL
-                const newConfig = new Configuration({
+                this.config = new Configuration({
                     basePath: newBaseUrl,
                     headers
                 });
-                this.api = new DefaultApi(newConfig);
+                this.api = new DefaultApi(this.config);
             } catch (error) {
                 throw new Error(
                     `Failed to start PMXT server: ${error}\n\n` +
@@ -334,6 +371,60 @@ export abstract class Exchange {
         }
     }
 
+    /**
+     * Search events (groups of related markets) by keyword.
+     * 
+     * @param query - Search query
+     * @param params - Optional filter parameters
+     * @returns List of matching events
+     * 
+     * @example
+     * ```typescript
+     * const events = await exchange.searchEvents("Trump");
+     * ```
+     */
+    async searchEvents(
+        query: string,
+        params?: MarketFilterParams
+    ): Promise<UnifiedEvent[]> {
+        await this.initPromise;
+        try {
+            const args: any[] = [query];
+            if (params) {
+                args.push(params);
+            }
+
+            const body: any = { args };
+            const credentials = this.getCredentials();
+            if (credentials) {
+                body.credentials = credentials;
+            }
+
+            // Manual implementation since generated client is missing this
+            const url = `${this.config.basePath}/api/${this.exchangeName}/searchEvents`;
+
+            const response = await fetch(url, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    ...this.config.headers
+                },
+                body: JSON.stringify(body)
+            });
+
+            if (!response.ok) {
+                const error = await response.json().catch(() => ({}));
+                throw new Error(error.error?.message || response.statusText);
+            }
+
+            const json = await response.json();
+            const data = this.handleResponse(json);
+            return data.map(convertEvent);
+        } catch (error) {
+            throw new Error(`Failed to search events: ${error}`);
+        }
+    }
+
     /**
      * Fetch markets by URL slug/ticker.
      * 
@@ -780,6 +871,67 @@ export abstract class Exchange {
             throw new Error(`Failed to fetch balance: ${error}`);
         }
     }
+
+    /**
+     * Calculate the average execution price for a given amount by walking the order book.
+     * Uses the sidecar server for calculation to ensure consistency.
+     * 
+     * @param orderBook - The current order book
+     * @param side - 'buy' or 'sell'
+     * @param amount - The amount to execute
+     * @returns The volume-weighted average price, or 0 if insufficient liquidity
+     */
+    async getExecutionPrice(orderBook: OrderBook, side: 'buy' | 'sell', amount: number): Promise<number> {
+        const result = await this.getExecutionPriceDetailed(orderBook, side, amount);
+        return result.fullyFilled ? result.price : 0;
+    }
+
+    /**
+     * Calculate detailed execution price information.
+     * Uses the sidecar server for calculation to ensure consistency.
+     * 
+     * @param orderBook - The current order book
+     * @param side - 'buy' or 'sell'
+     * @param amount - The amount to execute
+     * @returns Detailed execution result
+     */
+    async getExecutionPriceDetailed(
+        orderBook: OrderBook,
+        side: 'buy' | 'sell',
+        amount: number
+    ): Promise<ExecutionPriceResult> {
+        await this.initPromise;
+        try {
+            const body: any = {
+                args: [orderBook, side, amount]
+            };
+            const credentials = this.getCredentials();
+            if (credentials) {
+                body.credentials = credentials;
+            }
+
+            const url = `${this.config.basePath}/api/${this.exchangeName}/getExecutionPriceDetailed`;
+
+            const response = await fetch(url, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    ...this.config.headers
+                },
+                body: JSON.stringify(body)
+            });
+
+            if (!response.ok) {
+                const error = await response.json().catch(() => ({}));
+                throw new Error(error.error?.message || response.statusText);
+            }
+
+            const json = await response.json();
+            return this.handleResponse(json);
+        } catch (error) {
+            throw new Error(`Failed to get execution price: ${error}`);
+        }
+    }
 }
 
 /**

package/pmxt/models.ts

@@ -132,6 +132,20 @@ export interface OrderBook {
     timestamp?: number;
 }
 
+/**
+ * Result of an execution price calculation.
+ */
+export interface ExecutionPriceResult {
+    /** The volume-weighted average price */
+    price: number;
+
+    /** The actual amount that can be filled */
+    filledAmount: number;
+
+    /** Whether the full requested amount can be filled */
+    fullyFilled: boolean;
+}
+
 /**
  * A historical trade.
  */
@@ -302,3 +316,43 @@ export interface CreateOrderParams {
     /** Limit price (required for limit orders, 0.0-1.0) */
     price?: number;
 }
+/**
+ * A grouped collection of related markets (e.g., "Who will be Fed Chair?" contains multiple candidate markets)
+ */
+export interface UnifiedEvent {
+    /** Event ID */
+    id: string;
+
+    /** Event title */
+    title: string;
+
+    /** Event description */
+    description: string;
+
+    /** Event slug */
+    slug: string;
+
+    /** Related markets in this event */
+    markets: UnifiedMarket[];
+
+    /** Event URL */
+    url: string;
+
+    /** Event image URL */
+    image?: string;
+
+    /** Event category */
+    category?: string;
+
+    /** Event tags */
+    tags?: string[];
+
+    /**
+     * Search for markets within this event by keyword.
+     * 
+     * @param query - Search query (case-insensitive)
+     * @param searchIn - Where to search - "title", "description", or "both"
+     * @returns List of matching markets
+     */
+    searchMarkets(query: string, searchIn?: SearchIn): UnifiedMarket[];
+}