pmxtjs 2.33.4 → 2.34.0

package/dist/esm/generated/src/models/FetchMarketMatchesParams.d.ts

@@ -0,0 +1,86 @@
+/**
+ * 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 type { UnifiedMarket } from './UnifiedMarket.js';
+/**
+ *
+ * @export
+ * @interface FetchMarketMatchesParams
+ */
+export interface FetchMarketMatchesParams {
+    /**
+     * Pass a UnifiedMarket directly instead of marketId/slug/url.
+     * @type {UnifiedMarket}
+     * @memberof FetchMarketMatchesParams
+     */
+    market?: UnifiedMarket;
+    /**
+     *
+     * @type {string}
+     * @memberof FetchMarketMatchesParams
+     */
+    marketId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FetchMarketMatchesParams
+     */
+    slug?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FetchMarketMatchesParams
+     */
+    url?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FetchMarketMatchesParams
+     */
+    relation?: FetchMarketMatchesParamsRelationEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof FetchMarketMatchesParams
+     */
+    minConfidence?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof FetchMarketMatchesParams
+     */
+    limit?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FetchMarketMatchesParams
+     */
+    includePrices?: boolean;
+}
+/**
+ * @export
+ */
+export declare const FetchMarketMatchesParamsRelationEnum: {
+    readonly Identity: "identity";
+    readonly Subset: "subset";
+    readonly Superset: "superset";
+    readonly Overlap: "overlap";
+    readonly Disjoint: "disjoint";
+};
+export type FetchMarketMatchesParamsRelationEnum = typeof FetchMarketMatchesParamsRelationEnum[keyof typeof FetchMarketMatchesParamsRelationEnum];
+/**
+ * Check if a given object implements the FetchMarketMatchesParams interface.
+ */
+export declare function instanceOfFetchMarketMatchesParams(value: object): value is FetchMarketMatchesParams;
+export declare function FetchMarketMatchesParamsFromJSON(json: any): FetchMarketMatchesParams;
+export declare function FetchMarketMatchesParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FetchMarketMatchesParams;
+export declare function FetchMarketMatchesParamsToJSON(json: any): FetchMarketMatchesParams;
+export declare function FetchMarketMatchesParamsToJSONTyped(value?: FetchMarketMatchesParams | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/generated/src/models/{FetchMatchesParams.js → FetchMarketMatchesParams.js}

@@ -11,10 +11,11 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { UnifiedMarketFromJSON, UnifiedMarketToJSON, } from './UnifiedMarket.js';
 /**
  * @export
  */
-export const FetchMatchesParamsRelationEnum = {
+export const FetchMarketMatchesParamsRelationEnum = {
     Identity: 'identity',
     Subset: 'subset',
     Superset: 'superset',
@@ -22,19 +23,20 @@ export const FetchMatchesParamsRelationEnum = {
     Disjoint: 'disjoint'
 };
 /**
- * Check if a given object implements the FetchMatchesParams interface.
+ * Check if a given object implements the FetchMarketMatchesParams interface.
  */
-export function instanceOfFetchMatchesParams(value) {
+export function instanceOfFetchMarketMatchesParams(value) {
     return true;
 }
-export function FetchMatchesParamsFromJSON(json) {
-    return FetchMatchesParamsFromJSONTyped(json, false);
+export function FetchMarketMatchesParamsFromJSON(json) {
+    return FetchMarketMatchesParamsFromJSONTyped(json, false);
 }
-export function FetchMatchesParamsFromJSONTyped(json, ignoreDiscriminator) {
+export function FetchMarketMatchesParamsFromJSONTyped(json, ignoreDiscriminator) {
     if (json == null) {
         return json;
     }
     return {
+        'market': json['market'] == null ? undefined : UnifiedMarketFromJSON(json['market']),
         'marketId': json['marketId'] == null ? undefined : json['marketId'],
         'slug': json['slug'] == null ? undefined : json['slug'],
         'url': json['url'] == null ? undefined : json['url'],
@@ -44,14 +46,15 @@ export function FetchMatchesParamsFromJSONTyped(json, ignoreDiscriminator) {
         'includePrices': json['includePrices'] == null ? undefined : json['includePrices'],
     };
 }
-export function FetchMatchesParamsToJSON(json) {
-    return FetchMatchesParamsToJSONTyped(json, false);
+export function FetchMarketMatchesParamsToJSON(json) {
+    return FetchMarketMatchesParamsToJSONTyped(json, false);
 }
-export function FetchMatchesParamsToJSONTyped(value, ignoreDiscriminator = false) {
+export function FetchMarketMatchesParamsToJSONTyped(value, ignoreDiscriminator = false) {
     if (value == null) {
         return value;
     }
     return {
+        'market': UnifiedMarketToJSON(value['market']),
         'marketId': value['marketId'],
         'slug': value['slug'],
         'url': value['url'],

package/dist/esm/generated/src/models/UnifiedEvent.d.ts

@@ -82,6 +82,12 @@ export interface UnifiedEvent {
      * @memberof UnifiedEvent
      */
     tags?: Array<string>;
+    /**
+     * The exchange/venue this event originates from (e.g. 'polymarket', 'kalshi'). Populated by the Router.
+     * @type {string}
+     * @memberof UnifiedEvent
+     */
+    sourceExchange?: string;
 }
 /**
  * Check if a given object implements the UnifiedEvent interface.

package/dist/esm/generated/src/models/UnifiedEvent.js

@@ -51,6 +51,7 @@ export function UnifiedEventFromJSONTyped(json, ignoreDiscriminator) {
         'image': json['image'] == null ? undefined : json['image'],
         'category': json['category'] == null ? undefined : json['category'],
         'tags': json['tags'] == null ? undefined : json['tags'],
+        'sourceExchange': json['sourceExchange'] == null ? undefined : json['sourceExchange'],
     };
 }
 export function UnifiedEventToJSON(json) {
@@ -72,5 +73,6 @@ export function UnifiedEventToJSONTyped(value, ignoreDiscriminator = false) {
         'image': value['image'],
         'category': value['category'],
         'tags': value['tags'],
+        'sourceExchange': value['sourceExchange'],
     };
 }

package/dist/esm/generated/src/models/UnifiedMarket.d.ts

@@ -124,6 +124,12 @@ export interface UnifiedMarket {
      * @memberof UnifiedMarket
      */
     contractAddress?: string;
+    /**
+     * The exchange/venue this market originates from (e.g. 'polymarket', 'kalshi'). Populated by the Router.
+     * @type {string}
+     * @memberof UnifiedMarket
+     */
+    sourceExchange?: string;
     /**
      * Convenience accessor for the YES outcome on a binary market.
      * @type {MarketOutcome}

package/dist/esm/generated/src/models/UnifiedMarket.js

@@ -60,6 +60,7 @@ export function UnifiedMarketFromJSONTyped(json, ignoreDiscriminator) {
         'tickSize': json['tickSize'] == null ? undefined : json['tickSize'],
         'status': json['status'] == null ? undefined : json['status'],
         'contractAddress': json['contractAddress'] == null ? undefined : json['contractAddress'],
+        'sourceExchange': json['sourceExchange'] == null ? undefined : json['sourceExchange'],
         'yes': json['yes'] == null ? undefined : MarketOutcomeFromJSON(json['yes']),
         'no': json['no'] == null ? undefined : MarketOutcomeFromJSON(json['no']),
         'up': json['up'] == null ? undefined : MarketOutcomeFromJSON(json['up']),
@@ -92,6 +93,7 @@ export function UnifiedMarketToJSONTyped(value, ignoreDiscriminator = false) {
         'tickSize': value['tickSize'],
         'status': value['status'],
         'contractAddress': value['contractAddress'],
+        'sourceExchange': value['sourceExchange'],
         'yes': MarketOutcomeToJSON(value['yes']),
         'no': MarketOutcomeToJSON(value['no']),
         'up': MarketOutcomeToJSON(value['up']),

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

@@ -30,10 +30,10 @@ export * from './FetchEventMatches200Response.js';
 export * from './FetchEventMatchesParams.js';
 export * from './FetchEvents200Response.js';
 export * from './FetchMarket200Response.js';
+export * from './FetchMarketMatches200Response.js';
+export * from './FetchMarketMatchesParams.js';
 export * from './FetchMarkets200Response.js';
 export * from './FetchMarketsPaginated200Response.js';
-export * from './FetchMatches200Response.js';
-export * from './FetchMatchesParams.js';
 export * from './FetchMyTrades200Response.js';
 export * from './FetchOHLCV200Response.js';
 export * from './FetchOpenOrders200Response.js';

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

@@ -32,10 +32,10 @@ export * from './FetchEventMatches200Response.js';
 export * from './FetchEventMatchesParams.js';
 export * from './FetchEvents200Response.js';
 export * from './FetchMarket200Response.js';
+export * from './FetchMarketMatches200Response.js';
+export * from './FetchMarketMatchesParams.js';
 export * from './FetchMarkets200Response.js';
 export * from './FetchMarketsPaginated200Response.js';
-export * from './FetchMatches200Response.js';
-export * from './FetchMatchesParams.js';
 export * from './FetchMyTrades200Response.js';
 export * from './FetchOHLCV200Response.js';
 export * from './FetchOpenOrders200Response.js';

package/dist/esm/index.d.ts

@@ -18,10 +18,12 @@
  * ```
  */
 import { Exchange, Polymarket, Kalshi, KalshiDemo, Limitless, Myriad, Probable, Baozi, Opinion, Metaculus, Smarkets, PolymarketUS } from "./pmxt/client.js";
+import { Router } from "./pmxt/router.js";
 import { ServerManager } from "./pmxt/server-manager.js";
 import * as models from "./pmxt/models.js";
 import * as errors from "./pmxt/errors.js";
 export { Exchange, Polymarket, Kalshi, KalshiDemo, Limitless, Myriad, Probable, Baozi, Opinion, Metaculus, Smarkets, PolymarketUS, PolymarketOptions } from "./pmxt/client.js";
+export { Router } from "./pmxt/router.js";
 export { ServerManager } from "./pmxt/server-manager.js";
 export { MarketList } from "./pmxt/models.js";
 export type * from "./pmxt/models.js";
@@ -83,6 +85,7 @@ declare const pmxt: {
     Metaculus: typeof Metaculus;
     Smarkets: typeof Smarkets;
     PolymarketUS: typeof PolymarketUS;
+    Router: typeof Router;
     ServerManager: typeof ServerManager;
     server: {
         readonly status: () => Promise<{

package/dist/esm/index.js

@@ -18,10 +18,12 @@
  * ```
  */
 import { Exchange, Polymarket, Kalshi, KalshiDemo, Limitless, Myriad, Probable, Baozi, Opinion, Metaculus, Smarkets, PolymarketUS } from "./pmxt/client.js";
+import { Router } from "./pmxt/router.js";
 import { ServerManager } from "./pmxt/server-manager.js";
 import * as models from "./pmxt/models.js";
 import * as errors from "./pmxt/errors.js";
 export { Exchange, Polymarket, Kalshi, KalshiDemo, Limitless, Myriad, Probable, Baozi, Opinion, Metaculus, Smarkets, PolymarketUS } from "./pmxt/client.js";
+export { Router } from "./pmxt/router.js";
 export { ServerManager } from "./pmxt/server-manager.js";
 export { MarketList } from "./pmxt/models.js";
 export * from "./pmxt/errors.js";
@@ -67,6 +69,7 @@ const pmxt = {
     Metaculus,
     Smarkets,
     PolymarketUS,
+    Router,
     ServerManager,
     server,
     stopServer,

package/dist/esm/pmxt/client.js

@@ -99,6 +99,7 @@ function convertMarket(raw) {
         tickSize: raw.tickSize,
         status: raw.status,
         contractAddress: raw.contractAddress,
+        sourceExchange: raw.sourceExchange,
         eventId: raw.eventId,
         yes: convertOutcome(raw.yes),
         no: convertOutcome(raw.no),
@@ -202,6 +203,7 @@ function convertEvent(raw) {
         image: raw.image,
         category: raw.category,
         tags: raw.tags,
+        sourceExchange: raw.sourceExchange,
     };
     return event;
 }

package/dist/esm/pmxt/models.d.ts

@@ -62,6 +62,8 @@ export interface UnifiedMarket {
     status?: string;
     /** On-chain contract / condition identifier where applicable (Polymarket conditionId, etc.). */
     contractAddress?: string;
+    /** The exchange/venue this market originates from (e.g. 'polymarket', 'kalshi'). Populated by the Router. */
+    sourceExchange?: string;
     /** ID of the parent event this market belongs to */
     eventId?: string;
     /** Convenience access to the Yes outcome for binary markets. */
@@ -375,6 +377,8 @@ export interface UnifiedEvent {
     category?: string;
     /** Event tags */
     tags?: string[];
+    /** The exchange/venue this event originates from (e.g. 'polymarket', 'kalshi'). Populated by the Router. */
+    sourceExchange?: string;
 }
 /**
  * Advanced criteria for filtering markets.
@@ -483,3 +487,65 @@ export interface SubscribedAddressSnapshot {
     /** Unix timestamp (ms) of this snapshot */
     timestamp: number;
 }
+/** Set-theoretic relation between two markets' resolution conditions. */
+export type MatchRelation = 'identity' | 'subset' | 'superset' | 'overlap' | 'disjoint';
+/** A cross-venue market match with relation classification. */
+export interface MatchResult {
+    /** The matched market on another venue. */
+    market: UnifiedMarket;
+    /** Set-theoretic relation between the source and matched market. */
+    relation: MatchRelation;
+    /** Confidence score (0.0 to 1.0). */
+    confidence: number;
+    /** Human-readable explanation of the match. */
+    reasoning?: string;
+    /** Best bid price on the matched venue (when includePrices=true). */
+    bestBid?: number;
+    /** Best ask price on the matched venue (when includePrices=true). */
+    bestAsk?: number;
+}
+/** A cross-venue event match with constituent market matches. */
+export interface EventMatchResult {
+    /** The matched event on another venue. */
+    event: UnifiedEvent;
+    /** Cross-venue market matches within this event. */
+    marketMatches: MatchResult[];
+}
+/** Side-by-side price comparison for a matched market. */
+export interface PriceComparison {
+    /** The matched market. */
+    market: UnifiedMarket;
+    /** Relation type (typically 'identity' for price comparisons). */
+    relation: MatchRelation;
+    /** Confidence score (0.0 to 1.0). */
+    confidence: number;
+    /** Human-readable explanation. */
+    reasoning?: string;
+    /** Best bid price on this venue. */
+    bestBid?: number;
+    /** Best ask price on this venue. */
+    bestAsk?: number;
+    /** The venue name (e.g. 'kalshi', 'polymarket'). */
+    venue: string;
+}
+/** A cross-venue arbitrage opportunity. */
+export interface ArbitrageOpportunity {
+    /** Market on the buy side. */
+    marketA: UnifiedMarket;
+    /** Market on the sell side. */
+    marketB: UnifiedMarket;
+    /** Price spread (sellPrice - buyPrice). */
+    spread: number;
+    /** Venue to buy on. */
+    buyVenue: string;
+    /** Venue to sell on. */
+    sellVenue: string;
+    /** Price to buy at. */
+    buyPrice: number;
+    /** Price to sell at. */
+    sellPrice: number;
+    /** The set-theoretic relation between the two markets (e.g. identity, subset). */
+    relation?: MatchRelation;
+    /** Match confidence score (0.0 to 1.0). */
+    confidence?: number;
+}

package/dist/esm/pmxt/router.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Router — cross-venue intelligence layer.
+ *
+ * Search, match, compare prices, find hedges, and detect arbitrage across
+ * every venue PMXT supports. Only requires a PMXT API key.
+ */
+import { Exchange } from "./client.js";
+import { MatchResult, MatchRelation, EventMatchResult, PriceComparison, ArbitrageOpportunity, UnifiedMarket, UnifiedEvent } from "./models.js";
+/** Options for creating a Router. */
+export interface RouterOptions {
+    /** PMXT API key (required for hosted mode). */
+    pmxtApiKey?: string;
+    /** Override the base URL (defaults to hosted API). */
+    baseUrl?: string;
+    /** Start local sidecar (default: false). */
+    autoStartServer?: boolean;
+}
+/**
+ * Cross-venue intelligence layer.
+ *
+ * Search markets and events across every venue, find semantically
+ * equivalent markets on other platforms, compare prices, discover
+ * hedges, and scan for arbitrage — all from a single PMXT API key.
+ *
+ * @example
+ * ```typescript
+ * import pmxt from "pmxtjs";
+ *
+ * const router = new pmxt.Router({ pmxtApiKey: "pmxt_live_..." });
+ * const markets = await router.fetchMarkets({ query: "election" });
+ * const matches = await router.fetchMarketMatches({ market: markets[0] });
+ * ```
+ */
+export declare class Router extends Exchange {
+    constructor(options?: RouterOptions);
+    /**
+     * Find markets on other venues that correspond to a given market.
+     *
+     * @param params.market - A UnifiedMarket object (extracts marketId automatically).
+     * @param params.marketId - PMXT market ID.
+     * @param params.slug - Market slug (alternative to marketId).
+     * @param params.url - Market URL on the source venue.
+     * @param params.relation - Filter to a specific relation type.
+     * @param params.minConfidence - Minimum confidence threshold (0–1).
+     * @param params.limit - Maximum number of matches to return.
+     * @param params.includePrices - Attach live bestBid/bestAsk to each match.
+     */
+    fetchMarketMatches(params?: {
+        market?: UnifiedMarket;
+        marketId?: string;
+        slug?: string;
+        url?: string;
+        relation?: MatchRelation;
+        minConfidence?: number;
+        limit?: number;
+        includePrices?: boolean;
+    }): Promise<MatchResult[]>;
+    /**
+     * @deprecated Use {@link fetchMarketMatches} instead.
+     */
+    fetchMatches(params?: {
+        market?: UnifiedMarket;
+        marketId?: string;
+        slug?: string;
+        url?: string;
+        relation?: MatchRelation;
+        minConfidence?: number;
+        limit?: number;
+        includePrices?: boolean;
+    }): Promise<MatchResult[]>;
+    /**
+     * Match an entire event across venues.
+     *
+     * @param params.event - A UnifiedEvent object (extracts id automatically).
+     * @param params.eventId - PMXT event ID.
+     * @param params.slug - Event slug.
+     * @param params.relation - Filter market matches to a specific relation type.
+     * @param params.minConfidence - Minimum confidence threshold (0–1).
+     * @param params.limit - Maximum number of event matches to return.
+     * @param params.includePrices - Attach live prices to each market match.
+     */
+    fetchEventMatches(params?: {
+        event?: UnifiedEvent;
+        eventId?: string;
+        slug?: string;
+        relation?: MatchRelation;
+        minConfidence?: number;
+        limit?: number;
+        includePrices?: boolean;
+    }): Promise<EventMatchResult[]>;
+    /**
+     * Compare prices for the same market across venues.
+     *
+     * @param params.market - A UnifiedMarket object (extracts marketId automatically).
+     * @param params.marketId - PMXT market ID.
+     * @param params.slug - Market slug.
+     * @param params.url - Market URL.
+     */
+    compareMarketPrices(params?: {
+        market?: UnifiedMarket;
+        marketId?: string;
+        slug?: string;
+        url?: string;
+    }): Promise<PriceComparison[]>;
+    /**
+     * Find markets that partially hedge a position.
+     *
+     * @param params.market - A UnifiedMarket object (extracts marketId automatically).
+     * @param params.marketId - PMXT market ID.
+     * @param params.slug - Market slug.
+     * @param params.url - Market URL.
+     */
+    fetchHedges(params?: {
+        market?: UnifiedMarket;
+        marketId?: string;
+        slug?: string;
+        url?: string;
+    }): Promise<PriceComparison[]>;
+    /**
+     * Scan for cross-venue arbitrage opportunities.
+     *
+     * @param params.minSpread - Only return pairs with spread >= this value.
+     * @param params.category - Filter source markets by category.
+     * @param params.limit - Max source markets to scan (default: 50).
+     * @param params.relations - Relation types to include (default: ['identity']).
+     */
+    fetchArbitrage(params?: {
+        minSpread?: number;
+        category?: string;
+        limit?: number;
+        relations?: MatchRelation[];
+    }): Promise<ArbitrageOpportunity[]>;
+}