pmxtjs 2.33.4 → 2.34.0

package/generated/src/models/ArbitrageOpportunity.ts

@@ -69,8 +69,34 @@ export interface ArbitrageOpportunity {
      * @memberof ArbitrageOpportunity
      */
     sellPrice: number;
+    /**
+     * The set-theoretic relation between the two markets (e.g. identity, subset).
+     * @type {string}
+     * @memberof ArbitrageOpportunity
+     */
+    relation?: ArbitrageOpportunityRelationEnum;
+    /**
+     * Match confidence score (0.0 to 1.0).
+     * @type {number}
+     * @memberof ArbitrageOpportunity
+     */
+    confidence?: number;
 }
 
+
+/**
+ * @export
+ */
+export const ArbitrageOpportunityRelationEnum = {
+    Identity: 'identity',
+    Subset: 'subset',
+    Superset: 'superset',
+    Overlap: 'overlap',
+    Disjoint: 'disjoint'
+} as const;
+export type ArbitrageOpportunityRelationEnum = typeof ArbitrageOpportunityRelationEnum[keyof typeof ArbitrageOpportunityRelationEnum];
+
+
 /**
  * Check if a given object implements the ArbitrageOpportunity interface.
  */
@@ -102,6 +128,8 @@ export function ArbitrageOpportunityFromJSONTyped(json: any, ignoreDiscriminator
         'sellVenue': json['sellVenue'],
         'buyPrice': json['buyPrice'],
         'sellPrice': json['sellPrice'],
+        'relation': json['relation'] == null ? undefined : json['relation'],
+        'confidence': json['confidence'] == null ? undefined : json['confidence'],
     };
 }
 
@@ -123,6 +151,8 @@ export function ArbitrageOpportunityToJSONTyped(value?: ArbitrageOpportunity | n
         'sellVenue': value['sellVenue'],
         'buyPrice': value['buyPrice'],
         'sellPrice': value['sellPrice'],
+        'relation': value['relation'],
+        'confidence': value['confidence'],
     };
 }
 

package/generated/src/models/CompareMarketPricesRequest.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { FetchMarketMatchesParams } from './FetchMarketMatchesParams';
+import {
+    FetchMarketMatchesParamsFromJSON,
+    FetchMarketMatchesParamsFromJSONTyped,
+    FetchMarketMatchesParamsToJSON,
+    FetchMarketMatchesParamsToJSONTyped,
+} from './FetchMarketMatchesParams';
 import type { ExchangeCredentials } from './ExchangeCredentials';
 import {
     ExchangeCredentialsFromJSON,
@@ -20,13 +27,6 @@ import {
     ExchangeCredentialsToJSON,
     ExchangeCredentialsToJSONTyped,
 } from './ExchangeCredentials';
-import type { FetchMatchesParams } from './FetchMatchesParams';
-import {
-    FetchMatchesParamsFromJSON,
-    FetchMatchesParamsFromJSONTyped,
-    FetchMatchesParamsToJSON,
-    FetchMatchesParamsToJSONTyped,
-} from './FetchMatchesParams';
 
 /**
  * 
@@ -36,10 +36,10 @@ import {
 export interface CompareMarketPricesRequest {
     /**
      * 
-     * @type {Array<FetchMatchesParams>}
+     * @type {Array<FetchMarketMatchesParams>}
      * @memberof CompareMarketPricesRequest
      */
-    args: Array<FetchMatchesParams>;
+    args: Array<FetchMarketMatchesParams>;
     /**
      * 
      * @type {ExchangeCredentials}
@@ -66,7 +66,7 @@ export function CompareMarketPricesRequestFromJSONTyped(json: any, ignoreDiscrim
     }
     return {
         
-        'args': ((json['args'] as Array<any>).map(FetchMatchesParamsFromJSON)),
+        'args': ((json['args'] as Array<any>).map(FetchMarketMatchesParamsFromJSON)),
         'credentials': json['credentials'] == null ? undefined : ExchangeCredentialsFromJSON(json['credentials']),
     };
 }
@@ -82,7 +82,7 @@ export function CompareMarketPricesRequestToJSONTyped(value?: CompareMarketPrice
 
     return {
         
-        'args': ((value['args'] as Array<any>).map(FetchMatchesParamsToJSON)),
+        'args': ((value['args'] as Array<any>).map(FetchMarketMatchesParamsToJSON)),
         'credentials': ExchangeCredentialsToJSON(value['credentials']),
     };
 }

package/generated/src/models/FetchArbitrageParams.ts

@@ -37,8 +37,28 @@ export interface FetchArbitrageParams {
      * @memberof FetchArbitrageParams
      */
     limit?: number;
+    /**
+     * Comma-separated relation types to include (default: 'identity').
+     * @type {Array<string>}
+     * @memberof FetchArbitrageParams
+     */
+    relations?: Array<FetchArbitrageParamsRelationsEnum>;
 }
 
+
+/**
+ * @export
+ */
+export const FetchArbitrageParamsRelationsEnum = {
+    Identity: 'identity',
+    Subset: 'subset',
+    Superset: 'superset',
+    Overlap: 'overlap',
+    Disjoint: 'disjoint'
+} as const;
+export type FetchArbitrageParamsRelationsEnum = typeof FetchArbitrageParamsRelationsEnum[keyof typeof FetchArbitrageParamsRelationsEnum];
+
+
 /**
  * Check if a given object implements the FetchArbitrageParams interface.
  */
@@ -59,6 +79,7 @@ export function FetchArbitrageParamsFromJSONTyped(json: any, ignoreDiscriminator
         'minSpread': json['minSpread'] == null ? undefined : json['minSpread'],
         'category': json['category'] == null ? undefined : json['category'],
         'limit': json['limit'] == null ? undefined : json['limit'],
+        'relations': json['relations'] == null ? undefined : json['relations'],
     };
 }
 
@@ -76,6 +97,7 @@ export function FetchArbitrageParamsToJSONTyped(value?: FetchArbitrageParams | n
         'minSpread': value['minSpread'],
         'category': value['category'],
         'limit': value['limit'],
+        'relations': value['relations'],
     };
 }
 

package/generated/src/models/FetchEventMatchesParams.ts

@@ -13,12 +13,26 @@
  */
 
 import { mapValues } from '../runtime';
+import type { UnifiedEvent } from './UnifiedEvent';
+import {
+    UnifiedEventFromJSON,
+    UnifiedEventFromJSONTyped,
+    UnifiedEventToJSON,
+    UnifiedEventToJSONTyped,
+} from './UnifiedEvent';
+
 /**
  * 
  * @export
  * @interface FetchEventMatchesParams
  */
 export interface FetchEventMatchesParams {
+    /**
+     * Pass a UnifiedEvent directly instead of eventId/slug.
+     * @type {UnifiedEvent}
+     * @memberof FetchEventMatchesParams
+     */
+    event?: UnifiedEvent;
     /**
      * 
      * @type {string}
@@ -88,6 +102,7 @@ export function FetchEventMatchesParamsFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
+        'event': json['event'] == null ? undefined : UnifiedEventFromJSON(json['event']),
         'eventId': json['eventId'] == null ? undefined : json['eventId'],
         'slug': json['slug'] == null ? undefined : json['slug'],
         'relation': json['relation'] == null ? undefined : json['relation'],
@@ -108,6 +123,7 @@ export function FetchEventMatchesParamsToJSONTyped(value?: FetchEventMatchesPara
 
     return {
         
+        'event': UnifiedEventToJSON(value['event']),
         'eventId': value['eventId'],
         'slug': value['slug'],
         'relation': value['relation'],

package/generated/src/models/{FetchMatches200Response.ts → FetchMarketMatches200Response.ts}

@@ -31,41 +31,41 @@ import {
 /**
  * 
  * @export
- * @interface FetchMatches200Response
+ * @interface FetchMarketMatches200Response
  */
-export interface FetchMatches200Response {
+export interface FetchMarketMatches200Response {
     /**
      * 
      * @type {boolean}
-     * @memberof FetchMatches200Response
+     * @memberof FetchMarketMatches200Response
      */
     success?: boolean;
     /**
      * 
      * @type {ErrorDetail}
-     * @memberof FetchMatches200Response
+     * @memberof FetchMarketMatches200Response
      */
     error?: ErrorDetail;
     /**
      * 
      * @type {Array<MatchResult>}
-     * @memberof FetchMatches200Response
+     * @memberof FetchMarketMatches200Response
      */
     data?: Array<MatchResult>;
 }
 
 /**
- * Check if a given object implements the FetchMatches200Response interface.
+ * Check if a given object implements the FetchMarketMatches200Response interface.
  */
-export function instanceOfFetchMatches200Response(value: object): value is FetchMatches200Response {
+export function instanceOfFetchMarketMatches200Response(value: object): value is FetchMarketMatches200Response {
     return true;
 }
 
-export function FetchMatches200ResponseFromJSON(json: any): FetchMatches200Response {
-    return FetchMatches200ResponseFromJSONTyped(json, false);
+export function FetchMarketMatches200ResponseFromJSON(json: any): FetchMarketMatches200Response {
+    return FetchMarketMatches200ResponseFromJSONTyped(json, false);
 }
 
-export function FetchMatches200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FetchMatches200Response {
+export function FetchMarketMatches200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FetchMarketMatches200Response {
     if (json == null) {
         return json;
     }
@@ -77,11 +77,11 @@ export function FetchMatches200ResponseFromJSONTyped(json: any, ignoreDiscrimina
     };
 }
 
-export function FetchMatches200ResponseToJSON(json: any): FetchMatches200Response {
-    return FetchMatches200ResponseToJSONTyped(json, false);
+export function FetchMarketMatches200ResponseToJSON(json: any): FetchMarketMatches200Response {
+    return FetchMarketMatches200ResponseToJSONTyped(json, false);
 }
 
-export function FetchMatches200ResponseToJSONTyped(value?: FetchMatches200Response | null, ignoreDiscriminator: boolean = false): any {
+export function FetchMarketMatches200ResponseToJSONTyped(value?: FetchMarketMatches200Response | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }

package/generated/src/models/{FetchMatchesParams.ts → FetchMarketMatchesParams.ts}

@@ -13,52 +13,66 @@
  */
 
 import { mapValues } from '../runtime';
+import type { UnifiedMarket } from './UnifiedMarket';
+import {
+    UnifiedMarketFromJSON,
+    UnifiedMarketFromJSONTyped,
+    UnifiedMarketToJSON,
+    UnifiedMarketToJSONTyped,
+} from './UnifiedMarket';
+
 /**
  * 
  * @export
- * @interface FetchMatchesParams
+ * @interface FetchMarketMatchesParams
  */
-export interface FetchMatchesParams {
+export interface FetchMarketMatchesParams {
+    /**
+     * Pass a UnifiedMarket directly instead of marketId/slug/url.
+     * @type {UnifiedMarket}
+     * @memberof FetchMarketMatchesParams
+     */
+    market?: UnifiedMarket;
     /**
      * 
      * @type {string}
-     * @memberof FetchMatchesParams
+     * @memberof FetchMarketMatchesParams
      */
     marketId?: string;
     /**
      * 
      * @type {string}
-     * @memberof FetchMatchesParams
+     * @memberof FetchMarketMatchesParams
      */
     slug?: string;
     /**
      * 
      * @type {string}
-     * @memberof FetchMatchesParams
+     * @memberof FetchMarketMatchesParams
      */
     url?: string;
     /**
      * 
      * @type {string}
-     * @memberof FetchMatchesParams
+     * @memberof FetchMarketMatchesParams
      */
-    relation?: FetchMatchesParamsRelationEnum;
+    relation?: FetchMarketMatchesParamsRelationEnum;
     /**
      * 
      * @type {number}
-     * @memberof FetchMatchesParams
+     * @memberof FetchMarketMatchesParams
      */
     minConfidence?: number;
     /**
      * 
      * @type {number}
-     * @memberof FetchMatchesParams
+     * @memberof FetchMarketMatchesParams
      */
     limit?: number;
     /**
      * 
      * @type {boolean}
-     * @memberof FetchMatchesParams
+     * @memberof FetchMarketMatchesParams
      */
     includePrices?: boolean;
 }
@@ -67,33 +81,34 @@ export interface FetchMatchesParams {
 /**
  * @export
  */
-export const FetchMatchesParamsRelationEnum = {
+export const FetchMarketMatchesParamsRelationEnum = {
     Identity: 'identity',
     Subset: 'subset',
     Superset: 'superset',
     Overlap: 'overlap',
     Disjoint: 'disjoint'
 } as const;
-export type FetchMatchesParamsRelationEnum = typeof FetchMatchesParamsRelationEnum[keyof typeof FetchMatchesParamsRelationEnum];
+export type FetchMarketMatchesParamsRelationEnum = typeof FetchMarketMatchesParamsRelationEnum[keyof typeof FetchMarketMatchesParamsRelationEnum];
 
 
 /**
- * Check if a given object implements the FetchMatchesParams interface.
+ * Check if a given object implements the FetchMarketMatchesParams interface.
  */
-export function instanceOfFetchMatchesParams(value: object): value is FetchMatchesParams {
+export function instanceOfFetchMarketMatchesParams(value: object): value is FetchMarketMatchesParams {
     return true;
 }
 
-export function FetchMatchesParamsFromJSON(json: any): FetchMatchesParams {
-    return FetchMatchesParamsFromJSONTyped(json, false);
+export function FetchMarketMatchesParamsFromJSON(json: any): FetchMarketMatchesParams {
+    return FetchMarketMatchesParamsFromJSONTyped(json, false);
 }
 
-export function FetchMatchesParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FetchMatchesParams {
+export function FetchMarketMatchesParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FetchMarketMatchesParams {
     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'],
@@ -104,17 +119,18 @@ export function FetchMatchesParamsFromJSONTyped(json: any, ignoreDiscriminator:
     };
 }
 
-export function FetchMatchesParamsToJSON(json: any): FetchMatchesParams {
-    return FetchMatchesParamsToJSONTyped(json, false);
+export function FetchMarketMatchesParamsToJSON(json: any): FetchMarketMatchesParams {
+    return FetchMarketMatchesParamsToJSONTyped(json, false);
 }
 
-export function FetchMatchesParamsToJSONTyped(value?: FetchMatchesParams | null, ignoreDiscriminator: boolean = false): any {
+export function FetchMarketMatchesParamsToJSONTyped(value?: FetchMarketMatchesParams | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
 
     return {
         
+        'market': UnifiedMarketToJSON(value['market']),
         'marketId': value['marketId'],
         'slug': value['slug'],
         'url': value['url'],

package/generated/src/models/UnifiedEvent.ts

@@ -93,6 +93,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;
 }
 
 /**
@@ -130,6 +136,7 @@ export function UnifiedEventFromJSONTyped(json: any, ignoreDiscriminator: boolea
         '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'],
     };
 }
 
@@ -155,6 +162,7 @@ export function UnifiedEventToJSONTyped(value?: UnifiedEvent | null, ignoreDiscr
         'image': value['image'],
         'category': value['category'],
         'tags': value['tags'],
+        'sourceExchange': value['sourceExchange'],
     };
 }
 

package/generated/src/models/UnifiedMarket.ts

@@ -135,6 +135,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}
@@ -204,6 +210,7 @@ export function UnifiedMarketFromJSONTyped(json: any, ignoreDiscriminator: boole
         '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']),
@@ -240,6 +247,7 @@ export function UnifiedMarketToJSONTyped(value?: UnifiedMarket | null, ignoreDis
         '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/generated/src/models/index.ts

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

package/index.ts

@@ -20,11 +20,13 @@
 
 
 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";
@@ -77,6 +79,7 @@ const pmxt = {
     Metaculus,
     Smarkets,
     PolymarketUS,
+    Router,
     ServerManager,
     server,
     stopServer,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "2.33.4",
+  "version": "2.34.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.33.4"
+    "pmxt-core": "2.34.0"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",

package/pmxt/client.ts

@@ -132,6 +132,7 @@ function convertMarket(raw: any): UnifiedMarket {
         tickSize: raw.tickSize,
         status: raw.status,
         contractAddress: raw.contractAddress,
+        sourceExchange: raw.sourceExchange,
         eventId: raw.eventId,
         yes: convertOutcome(raw.yes),
         no: convertOutcome(raw.no),
@@ -247,6 +248,7 @@ function convertEvent(raw: any): UnifiedEvent {
         image: raw.image,
         category: raw.category,
         tags: raw.tags,
+        sourceExchange: raw.sourceExchange,
     };
 
     return event;

package/pmxt/models.ts

@@ -86,6 +86,9 @@ export interface UnifiedMarket {
     /** 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;
 
@@ -545,6 +548,9 @@ export interface UnifiedEvent {
 
     /** Event tags */
     tags?: string[];
+
+    /** The exchange/venue this event originates from (e.g. 'polymarket', 'kalshi'). Populated by the Router. */
+    sourceExchange?: string;
 }
 
 // ----------------------------------------------------------------------------
@@ -664,3 +670,94 @@ export interface SubscribedAddressSnapshot {
     /** Unix timestamp (ms) of this snapshot */
     timestamp: number;
 }
+
+// ----------------------------------------------------------------------------
+// Router Types
+// ----------------------------------------------------------------------------
+
+/** 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;
+}