pmxtjs 2.51.2 → 2.51.3

package/generated/docs/Trade.md

@@ -13,32 +13,6 @@ Name | Type
 `side` | string
 `outcomeId` | string
 
-## Example
-
-```typescript
-import type { Trade } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "timestamp": null,
-  "price": null,
-  "amount": null,
-  "side": null,
-  "outcomeId": null,
-} satisfies Trade
-
-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 Trade
-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/TradesParams.md

@@ -10,29 +10,6 @@ Name | Type
 `end` | Date
 `limit` | number
 
-## Example
-
-```typescript
-import type { TradesParams } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "start": null,
-  "end": null,
-  "limit": null,
-} satisfies TradesParams
-
-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 TradesParams
-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

@@ -21,39 +21,6 @@ Name | Type
 `sourceMetadata` | { [key: string]: any; }
 `sourceExchange` | string
 
-## Example
-
-```typescript
-import type { UnifiedEvent } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "title": null,
-  "description": null,
-  "slug": null,
-  "markets": null,
-  "volume24h": null,
-  "volume": null,
-  "url": null,
-  "image": null,
-  "category": null,
-  "tags": null,
-  "sourceMetadata": null,
-  "sourceExchange": null,
-} satisfies UnifiedEvent
-
-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 UnifiedEvent
-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/UnifiedMarket.md

@@ -31,50 +31,6 @@ Name | Type
 `up` | [MarketOutcome](MarketOutcome.md)
 `down` | [MarketOutcome](MarketOutcome.md)
 
-## Example
-
-```typescript
-import type { UnifiedMarket } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "marketId": null,
-  "eventId": null,
-  "title": null,
-  "description": null,
-  "slug": null,
-  "outcomes": null,
-  "resolutionDate": null,
-  "volume24h": null,
-  "volume": null,
-  "liquidity": null,
-  "openInterest": null,
-  "url": null,
-  "image": null,
-  "category": null,
-  "tags": null,
-  "tickSize": null,
-  "status": null,
-  "contractAddress": null,
-  "sourceMetadata": null,
-  "sourceExchange": null,
-  "yes": null,
-  "no": null,
-  "up": null,
-  "down": null,
-} satisfies UnifiedMarket
-
-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 UnifiedMarket
-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/UnifiedSeries.md

@@ -19,37 +19,6 @@ Name | Type
 `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/docs/UserTrade.md

@@ -19,38 +19,6 @@ Name | Type
 `chain` | string
 `blockNumber` | number
 
-## Example
-
-```typescript
-import type { UserTrade } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "timestamp": null,
-  "price": null,
-  "amount": null,
-  "side": null,
-  "outcomeId": null,
-  "orderId": null,
-  "marketId": null,
-  "fee": null,
-  "txHash": null,
-  "chain": null,
-  "blockNumber": null,
-} satisfies UserTrade
-
-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 UserTrade
-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.51.2",
+  "version": "2.51.3",
   "description": "OpenAPI client for pmxtjs",
   "author": "OpenAPI-Generator",
   "repository": {

package/generated/src/apis/DefaultApi.ts

@@ -676,6 +676,7 @@ export class DefaultApi extends runtime.BaseAPI {
     }
 
     /**
+     * Fetch authenticated order history across open and closed orders.
      * Fetch All Orders
      */
     async fetchAllOrdersRaw(requestParameters: FetchAllOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchOpenOrders200Response>> {
@@ -725,6 +726,7 @@ export class DefaultApi extends runtime.BaseAPI {
     }
 
     /**
+     * Fetch authenticated order history across open and closed orders.
      * Fetch All Orders
      */
     async fetchAllOrders(requestParameters: FetchAllOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchOpenOrders200Response> {
@@ -831,6 +833,7 @@ export class DefaultApi extends runtime.BaseAPI {
     }
 
     /**
+     * Fetch authenticated closed orders.
      * Fetch Closed Orders
      */
     async fetchClosedOrdersRaw(requestParameters: FetchClosedOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchOpenOrders200Response>> {
@@ -880,6 +883,7 @@ export class DefaultApi extends runtime.BaseAPI {
     }
 
     /**
+     * Fetch authenticated closed orders.
      * Fetch Closed Orders
      */
     async fetchClosedOrders(requestParameters: FetchClosedOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchOpenOrders200Response> {
@@ -1737,6 +1741,7 @@ export class DefaultApi extends runtime.BaseAPI {
     }
 
     /**
+     * Fetch authenticated user trade history.
      * Fetch My Trades
      */
     async fetchMyTradesRaw(requestParameters: FetchMyTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchMyTrades200Response>> {
@@ -1790,6 +1795,7 @@ export class DefaultApi extends runtime.BaseAPI {
     }
 
     /**
+     * Fetch authenticated user trade history.
      * Fetch My Trades
      */
     async fetchMyTrades(requestParameters: FetchMyTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchMyTrades200Response> {

package/generated/src/models/CreateOrderParams.ts

@@ -55,6 +55,18 @@ export interface CreateOrderParams {
      * @memberof CreateOrderParams
      */
     price?: number;
+    /**
+     * Hosted mode: amount unit.
+     * @type {string}
+     * @memberof CreateOrderParams
+     */
+    denom?: CreateOrderParamsDenomEnum;
+    /**
+     * Hosted mode: maximum market-order slippage percentage.
+     * @type {number}
+     * @memberof CreateOrderParams
+     */
+    slippagePct?: number;
     /**
      * Optional fee rate (e.g., 1000 for 0.1%)
      * @type {number}
@@ -100,6 +112,15 @@ export const CreateOrderParamsTypeEnum = {
 } as const;
 export type CreateOrderParamsTypeEnum = typeof CreateOrderParamsTypeEnum[keyof typeof CreateOrderParamsTypeEnum];
 
+/**
+ * @export
+ */
+export const CreateOrderParamsDenomEnum = {
+    Usdc: 'usdc',
+    Shares: 'shares'
+} as const;
+export type CreateOrderParamsDenomEnum = typeof CreateOrderParamsDenomEnum[keyof typeof CreateOrderParamsDenomEnum];
+
 
 /**
  * Check if a given object implements the CreateOrderParams interface.
@@ -129,6 +150,8 @@ export function CreateOrderParamsFromJSONTyped(json: any, ignoreDiscriminator: b
         'type': json['type'],
         'amount': json['amount'],
         'price': json['price'] == null ? undefined : json['price'],
+        'denom': json['denom'] == null ? undefined : json['denom'],
+        'slippagePct': json['slippage_pct'] == null ? undefined : json['slippage_pct'],
         'fee': json['fee'] == null ? undefined : json['fee'],
         'tickSize': json['tickSize'] == null ? undefined : json['tickSize'],
         'negRisk': json['negRisk'] == null ? undefined : json['negRisk'],
@@ -153,6 +176,8 @@ export function CreateOrderParamsToJSONTyped(value?: CreateOrderParams | null, i
         'type': value['type'],
         'amount': value['amount'],
         'price': value['price'],
+        'denom': value['denom'],
+        'slippage_pct': value['slippagePct'],
         'fee': value['fee'],
         'tickSize': value['tickSize'],
         'negRisk': value['negRisk'],

package/package.json

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

package/pmxt/client.ts

@@ -17,7 +17,7 @@ import {
 import {
     Balance,
     BuiltOrder,
-    CreateOrderParams,
+    CreateOrderInput,
     EventFetchParams,
     EventFilterCriteria,
     EventFilterFunction,
@@ -82,6 +82,7 @@ import {
     validateEconomics,
     verifySignature,
 } from "./hosted-typed-data.js";
+import type { HostedRoute } from "./hosted-typed-data.js";
 import type { Signer, TypedData } from "./signers.js";
 import { signerFromPrivateKey, EthersSigner } from "./signers.js";
 import { Escrow } from "./escrow.js";
@@ -2011,7 +2012,13 @@ export abstract class Exchange {
         throw this.wsTransportUnavailableError("watchAllOrderBooks");
     }
 
-    /** @deprecated Use {@link watchAllOrderBooks} instead. */
+    /**
+     * Stream all orderbook updates across venues.
+     *
+     * @deprecated Use {@link watchAllOrderBooks} instead.
+     * @param venues - Optional venue filter
+     * @returns Next event with source, symbol, and orderbook
+     */
     async firehose(venues?: string[]): Promise<FirehoseEvent> {
         return this.watchAllOrderBooks(venues);
     }
@@ -2148,15 +2155,18 @@ export abstract class Exchange {
      * const order = await exchange.submitOrder(built);
      *
      * // Using outcome shorthand:
+     * const yes = market.yes;
+     * if (!yes) throw new Error("Market has no YES outcome");
+     *
      * const built2 = await exchange.buildOrder({
-     *   outcome: market.yes,
+     *   outcome: yes,
      *   side: "buy",
      *   type: "market",
      *   amount: 10
      * });
      * ```
      */
-    async buildOrder(params: CreateOrderParams & { outcome?: MarketOutcome }): Promise<BuiltOrder> {
+    async buildOrder(params: CreateOrderInput): Promise<BuiltOrder> {
         if (this.isHostedTradingMode()) {
             return this._hostedBuildOrder(params);
         }
@@ -2310,7 +2320,7 @@ export abstract class Exchange {
      * at submit time.
      */
     private async _hostedBuildOrder(
-        params: CreateOrderParams & { outcome?: MarketOutcome },
+        params: CreateOrderInput,
     ): Promise<BuiltOrder> {
         const body = this._hostedBuildOrderBody(params);
         const route = HOSTED_METHOD_ROUTES.get("buildOrder")!;
@@ -2328,7 +2338,7 @@ export abstract class Exchange {
     /**
      * Hosted-mode createOrder: build → sign → submit single-call wrapper.
      */
-    private async _hostedCreateOrder(params: any): Promise<Order> {
+    private async _hostedCreateOrder(params: CreateOrderInput): Promise<Order> {
         const built = await this._hostedBuildOrder(params);
         return this._hostedSubmitOrder(built);
     }
@@ -2392,7 +2402,7 @@ export abstract class Exchange {
      * `validateTypedData` / `validateEconomics`. Returns the cross-chain
      * pull-leg route name for Opinion sells and Limitless cross-chain orders.
      */
-    private _hostedTypedDataRoute(side: string, isPull: boolean): string {
+    private _hostedTypedDataRoute(side: string, isPull: boolean): HostedRoute {
         const venue = this.exchangeName;
         const sideLower = side.toLowerCase();
         if (venue === "polymarket") {
@@ -2457,10 +2467,12 @@ export abstract class Exchange {
         return orderFromV0(data as Record<string, unknown>);
     }
 
-    private _hostedCancelTypedDataRoute(isPull: boolean): string {
+    private _hostedCancelTypedDataRoute(isPull: boolean): HostedRoute {
         const venue = this.exchangeName;
         if (venue === "polymarket") return "cancel_polymarket";
-        if (venue === "limitless") return isPull ? "cancel_limitless_base_pull" : "cancel_limitless_polygon";
+        if (venue === "limitless") {
+            return isPull ? "cancel_limitless_base_pull" : "cancel_limitless_polygon";
+        }
         return isPull ? "cancel_opinion_bsc_pull" : "cancel_opinion_polygon";
     }
 
@@ -2470,7 +2482,7 @@ export abstract class Exchange {
      * precision rejected via {@link to6dec}).
      */
     private _hostedBuildOrderBody(
-        params: CreateOrderParams & { outcome?: MarketOutcome },
+        params: CreateOrderInput,
     ): Record<string, unknown> {
         let marketId: string | undefined = params.marketId;
         let outcomeId: string | undefined = params.outcomeId;
@@ -2592,7 +2604,7 @@ export abstract class Exchange {
      * });
      * ```
      */
-    async createOrder(params: CreateOrderParams & { outcome?: MarketOutcome }): Promise<Order> {
+    async createOrder(params: CreateOrderInput): Promise<Order> {
         // SOR escape path (preserved): legacy hosted SOR flow uses a venue-side
         // SDK to execute the legs, only when a privateKey is present.
         if (this.isHosted && this.exchangeName === 'sor' && this.privateKey) {
@@ -3153,6 +3165,75 @@ export class Limitless extends Exchange {
     constructor(options: ExchangeOptions = {}) {
         super("limitless", options);
     }
+
+    /**
+     * Watch real-time AMM price updates via WebSocket.
+     *
+     * @param marketAddress - Limitless market contract address
+     * @param callback - Optional callback invoked with the returned update
+     * @returns Next price update
+     */
+    async watchPrices(
+        marketAddress: string,
+        callback?: (data: Record<string, any>) => void,
+    ): Promise<Record<string, any>> {
+        await this.initPromise;
+        try {
+            const json = await this.sidecarPostRequest("watchPrices", [marketAddress]);
+            const data = this.handleResponse(json);
+            callback?.(data);
+            return data;
+        } catch (error) {
+            if (error instanceof PmxtError) throw error;
+            throw new PmxtError(`Failed to watch prices: ${error}`);
+        }
+    }
+
+    /**
+     * Watch real-time Limitless user position updates.
+     *
+     * Requires API key authentication.
+     *
+     * @param callback - Optional callback invoked with the returned positions
+     * @returns Next position update payload
+     */
+    async watchUserPositions(
+        callback?: (data: Position[]) => void,
+    ): Promise<Position[]> {
+        await this.initPromise;
+        try {
+            const json = await this.sidecarPostRequest("watchUserPositions", []);
+            const data = this.handleResponse(json).map(convertPosition);
+            callback?.(data);
+            return data;
+        } catch (error) {
+            if (error instanceof PmxtError) throw error;
+            throw new PmxtError(`Failed to watch user positions: ${error}`);
+        }
+    }
+
+    /**
+     * Watch real-time Limitless user transaction updates.
+     *
+     * Requires API key authentication.
+     *
+     * @param callback - Optional callback invoked with the returned update
+     * @returns Next transaction update
+     */
+    async watchUserTransactions(
+        callback?: (data: Record<string, any>) => void,
+    ): Promise<Record<string, any>> {
+        await this.initPromise;
+        try {
+            const json = await this.sidecarPostRequest("watchUserTransactions", []);
+            const data = this.handleResponse(json);
+            callback?.(data);
+            return data;
+        } catch (error) {
+            if (error instanceof PmxtError) throw error;
+            throw new PmxtError(`Failed to watch user transactions: ${error}`);
+        }
+    }
 }
 
 /**

package/pmxt/hosted-typed-data.ts

@@ -141,7 +141,9 @@ export type HostedRoute =
     | "opinion_sell_bsc_pull"
     | "cancel_polymarket"
     | "cancel_opinion_polygon"
-    | "cancel_opinion_bsc_pull";
+    | "cancel_opinion_bsc_pull"
+    | "cancel_limitless_polygon"
+    | "cancel_limitless_base_pull";
 
 const SCHEMAS: Readonly<Record<HostedRoute, TypedDataSchema>> = {
     polymarket_buy: {
@@ -221,6 +223,20 @@ const SCHEMAS: Readonly<Record<HostedRoute, TypedDataSchema>> = {
         messageKeys: messageKeysFromFields(CANCEL_PULL_FIELDS),
         walletField: "user",
     },
+    cancel_limitless_polygon: {
+        primaryType: "CancelOrder",
+        domain: PREFUNDED_DOMAIN,
+        fields: CANCEL_ORDER_FIELDS,
+        messageKeys: messageKeysFromFields(CANCEL_ORDER_FIELDS),
+        walletField: "user",
+    },
+    cancel_limitless_base_pull: {
+        primaryType: "CancelPull",
+        domain: LIMITLESS_VENUE_DOMAIN,
+        fields: CANCEL_PULL_FIELDS,
+        messageKeys: messageKeysFromFields(CANCEL_PULL_FIELDS),
+        walletField: "user",
+    },
 };
 
 // secp256k1 group order / 2, for canonical low-s check.

package/pmxt/models.ts

@@ -549,6 +549,12 @@ export interface CreateOrderParams {
     /** Limit price (required for limit orders, 0.0-1.0) */
     price?: number;
 
+    /** Hosted mode: unit that amount is denominated in. Market buys use usdc; market sells and limit orders use shares. */
+    denom?: "usdc" | "shares";
+
+    /** Hosted mode: maximum slippage percentage for market orders. */
+    slippage_pct?: number;
+
     /** Optional fee rate (e.g., 1000 for 0.1%) */
     fee?: number;
 
@@ -562,6 +568,20 @@ export interface CreateOrderParams {
     onBehalfOf?: number;
 }
 
+/**
+ * Public order input accepted by createOrder/buildOrder.
+ *
+ * Callers can either pass explicit marketId/outcomeId fields, or pass an
+ * outcome object returned by fetchMarkets and let the SDK infer those ids.
+ */
+export type CreateOrderInput =
+    | (CreateOrderParams & { outcome?: never })
+    | (Omit<CreateOrderParams, 'marketId' | 'outcomeId'> & {
+        outcome: MarketOutcome;
+        marketId?: never;
+        outcomeId?: never;
+    });
+
 /** Alias matching the core MarketFetchParams name. */
 export type MarketFetchParams = MarketFilterParams;