pmxtjs 2.51.2 → 2.51.3

package/dist/pmxt/client.d.ts

@@ -5,7 +5,7 @@
  * OpenAPI client, matching the Python API exactly.
  */
 import { Configuration, DefaultApi, ExchangeCredentials } from "../generated/src/index.js";
-import { Balance, BuiltOrder, CreateOrderParams, EventFetchParams, EventFilterCriteria, EventFilterFunction, ExecutionPriceResult, FetchOrderBookParams, MarketFetchParams, MarketFilterCriteria, MarketFilterFunction, MarketOutcome, MyTradesParams, Order, OrderBook, OrderHistoryParams, PaginatedMarketsResult, PaginatedEventsResult, Position, SeriesFetchParams, PriceCandle, SubscribedAddressSnapshot, SubscriptionOption, Trade, UnifiedEvent, UnifiedMarket, UnifiedSeries, UserTrade, FirehoseEvent, FetchMatchedMarketClustersParams } from "./models.js";
+import { Balance, BuiltOrder, CreateOrderInput, EventFetchParams, EventFilterCriteria, EventFilterFunction, ExecutionPriceResult, FetchOrderBookParams, MarketFetchParams, MarketFilterCriteria, MarketFilterFunction, MarketOutcome, MyTradesParams, Order, OrderBook, OrderHistoryParams, PaginatedMarketsResult, PaginatedEventsResult, Position, SeriesFetchParams, PriceCandle, SubscribedAddressSnapshot, SubscriptionOption, Trade, UnifiedEvent, UnifiedMarket, UnifiedSeries, UserTrade, FirehoseEvent, FetchMatchedMarketClustersParams } from "./models.js";
 import { ServerManager } from "./server-manager.js";
 import type { Signer } from "./signers.js";
 import { Escrow } from "./escrow.js";
@@ -336,7 +336,13 @@ export declare abstract class Exchange {
      * ```
      */
     watchAllOrderBooks(venues?: string[]): Promise<FirehoseEvent>;
-    /** @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
+     */
     firehose(venues?: string[]): Promise<FirehoseEvent>;
     /**
      * Watch real-time trade updates via WebSocket.
@@ -412,17 +418,18 @@ export declare 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
      * });
      * ```
      */
-    buildOrder(params: CreateOrderParams & {
-        outcome?: MarketOutcome;
-    }): Promise<BuiltOrder>;
+    buildOrder(params: CreateOrderInput): Promise<BuiltOrder>;
     private _discoverHostedAccount;
     private _executeSorOrder;
     /**
@@ -476,9 +483,7 @@ export declare abstract class Exchange {
      * });
      * ```
      */
-    createOrder(params: CreateOrderParams & {
-        outcome?: MarketOutcome;
-    }): Promise<Order>;
+    createOrder(params: CreateOrderInput): Promise<Order>;
     /**
      * Calculate the average execution price for a given amount by walking the order book.
      * Uses the sidecar server for calculation to ensure consistency.
@@ -635,6 +640,32 @@ export declare class Kalshi extends Exchange {
  */
 export declare class Limitless extends Exchange {
     constructor(options?: ExchangeOptions);
+    /**
+     * 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
+     */
+    watchPrices(marketAddress: string, callback?: (data: Record<string, any>) => void): Promise<Record<string, any>>;
+    /**
+     * 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
+     */
+    watchUserPositions(callback?: (data: Position[]) => void): Promise<Position[]>;
+    /**
+     * Watch real-time Limitless user transaction updates.
+     *
+     * Requires API key authentication.
+     *
+     * @param callback - Optional callback invoked with the returned update
+     * @returns Next transaction update
+     */
+    watchUserTransactions(callback?: (data: Record<string, any>) => void): Promise<Record<string, any>>;
 }
 /**
  * Kalshi Demo exchange client (paper trading / sandbox environment).

package/dist/pmxt/client.js

@@ -1810,7 +1810,13 @@ 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) {
         return this.watchAllOrderBooks(venues);
     }
@@ -1935,8 +1941,11 @@ 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
@@ -2229,8 +2238,9 @@ class Exchange {
         const venue = this.exchangeName;
         if (venue === "polymarket")
             return "cancel_polymarket";
-        if (venue === "limitless")
+        if (venue === "limitless") {
             return isPull ? "cancel_limitless_base_pull" : "cancel_limitless_polygon";
+        }
         return isPull ? "cancel_opinion_bsc_pull" : "cancel_opinion_polygon";
     }
     /**
@@ -2806,6 +2816,71 @@ class Limitless extends Exchange {
     constructor(options = {}) {
         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, callback) {
+        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 errors_js_1.PmxtError)
+                throw error;
+            throw new errors_js_1.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) {
+        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 errors_js_1.PmxtError)
+                throw error;
+            throw new errors_js_1.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) {
+        await this.initPromise;
+        try {
+            const json = await this.sidecarPostRequest("watchUserTransactions", []);
+            const data = this.handleResponse(json);
+            callback?.(data);
+            return data;
+        }
+        catch (error) {
+            if (error instanceof errors_js_1.PmxtError)
+                throw error;
+            throw new errors_js_1.PmxtError(`Failed to watch user transactions: ${error}`);
+        }
+    }
 }
 exports.Limitless = Limitless;
 /**

package/dist/pmxt/hosted-typed-data.d.ts

@@ -9,7 +9,7 @@
  * Layer 3 uses the optional `ethers` peer dependency for typed-data verification.
  */
 import { TypedData } from "./signers";
-export type HostedRoute = "polymarket_buy" | "polymarket_sell" | "limitless_buy" | "limitless_sell_polygon" | "limitless_sell_base_pull" | "opinion_buy" | "opinion_sell_polygon" | "opinion_sell_bsc_pull" | "cancel_polymarket" | "cancel_opinion_polygon" | "cancel_opinion_bsc_pull";
+export type HostedRoute = "polymarket_buy" | "polymarket_sell" | "limitless_buy" | "limitless_sell_polygon" | "limitless_sell_base_pull" | "opinion_buy" | "opinion_sell_polygon" | "opinion_sell_bsc_pull" | "cancel_polymarket" | "cancel_opinion_polygon" | "cancel_opinion_bsc_pull" | "cancel_limitless_polygon" | "cancel_limitless_base_pull";
 export declare const SECP256K1_HALF_N = 57896044618658097711785492504343953926418782139537452191302581570759080747168n;
 /**
  * Validate the structural shape of a typed-data payload before signing.

package/dist/pmxt/hosted-typed-data.js

@@ -211,6 +211,20 @@ const SCHEMAS = {
         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.
 exports.SECP256K1_HALF_N = 0x7fffffffffffffffffffffffffffffff5d576e7357a4501ddfe92f46681b20a0n;

package/dist/pmxt/models.d.ts

@@ -400,6 +400,10 @@ export interface CreateOrderParams {
     amount: number;
     /** 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;
     /** Optional override for Limitless/Polymarket */
@@ -409,6 +413,19 @@ export interface CreateOrderParams {
     /** Limitless delegated signing: profile ID to trade on behalf of */
     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;
 /**

package/generated/docs/ArbitrageOpportunity.md

@@ -16,35 +16,6 @@ Name | Type
 `relation` | string
 `confidence` | number
 
-## Example
-
-```typescript
-import type { ArbitrageOpportunity } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "marketA": null,
-  "marketB": null,
-  "spread": null,
-  "buyVenue": null,
-  "sellVenue": null,
-  "buyPrice": null,
-  "sellPrice": null,
-  "relation": null,
-  "confidence": null,
-} satisfies ArbitrageOpportunity
-
-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 ArbitrageOpportunity
-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/Balance.md

@@ -12,31 +12,6 @@ Name | Type
 `locked` | number
 `venue` | string
 
-## Example
-
-```typescript
-import type { Balance } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "currency": null,
-  "total": null,
-  "available": null,
-  "locked": null,
-  "venue": null,
-} satisfies Balance
-
-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 Balance
-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/BaseRequest.md

@@ -9,27 +9,6 @@ Name | Type
 ------------ | -------------
 `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
 
-## Example
-
-```typescript
-import type { BaseRequest } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "credentials": null,
-} satisfies BaseRequest
-
-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 BaseRequest
-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/BaseResponse.md

@@ -9,28 +9,6 @@ Name | Type
 `success` | boolean
 `error` | [ErrorDetail](ErrorDetail.md)
 
-## Example
-
-```typescript
-import type { BaseResponse } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "success": true,
-  "error": null,
-} satisfies BaseResponse
-
-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 BaseResponse
-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/BuildOrder200Response.md

@@ -10,29 +10,6 @@ Name | Type
 `error` | [ErrorDetail](ErrorDetail.md)
 `data` | [BuiltOrder](BuiltOrder.md)
 
-## Example
-
-```typescript
-import type { BuildOrder200Response } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "success": true,
-  "error": null,
-  "data": null,
-} satisfies BuildOrder200Response
-
-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 BuildOrder200Response
-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/BuildOrderRequest.md

@@ -9,28 +9,6 @@ Name | Type
 `args` | [Array<CreateOrderParams>](CreateOrderParams.md)
 `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
 
-## Example
-
-```typescript
-import type { BuildOrderRequest } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "args": null,
-  "credentials": null,
-} satisfies BuildOrderRequest
-
-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 BuildOrderRequest
-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/BuiltOrder.md

@@ -13,32 +13,6 @@ Name | Type
 `raw` | any
 `expiry` | number
 
-## Example
-
-```typescript
-import type { BuiltOrder } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "exchange": null,
-  "params": null,
-  "signedOrder": null,
-  "tx": null,
-  "raw": null,
-  "expiry": null,
-} satisfies BuiltOrder
-
-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 BuiltOrder
-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/BuiltOrderTx.md

@@ -12,30 +12,6 @@ Name | Type
 `value` | string
 `chainId` | number
 
-## Example
-
-```typescript
-import type { BuiltOrderTx } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "to": null,
-  "data": null,
-  "value": null,
-  "chainId": null,
-} satisfies BuiltOrderTx
-
-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 BuiltOrderTx
-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/CancelOrderRequest.md

@@ -9,28 +9,6 @@ Name | Type
 `args` | Array<string>
 `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
 
-## Example
-
-```typescript
-import type { CancelOrderRequest } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "args": null,
-  "credentials": null,
-} satisfies CancelOrderRequest
-
-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 CancelOrderRequest
-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/CloseRequest.md

@@ -9,28 +9,6 @@ Name | Type
 `args` | Array<any>
 `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
 
-## Example
-
-```typescript
-import type { CloseRequest } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "args": null,
-  "credentials": null,
-} satisfies CloseRequest
-
-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 CloseRequest
-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/CompareMarketPrices200Response.md

@@ -10,29 +10,6 @@ Name | Type
 `error` | [ErrorDetail](ErrorDetail.md)
 `data` | [Array<PriceComparison>](PriceComparison.md)
 
-## Example
-
-```typescript
-import type { CompareMarketPrices200Response } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "success": true,
-  "error": null,
-  "data": null,
-} satisfies CompareMarketPrices200Response
-
-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 CompareMarketPrices200Response
-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/CompareMarketPricesRequest.md

@@ -9,28 +9,6 @@ Name | Type
 `args` | [Array<FetchMarketMatchesParams>](FetchMarketMatchesParams.md)
 `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
 
-## Example
-
-```typescript
-import type { CompareMarketPricesRequest } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "args": null,
-  "credentials": null,
-} satisfies CompareMarketPricesRequest
-
-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 CompareMarketPricesRequest
-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/CreateOrder200Response.md

@@ -10,29 +10,6 @@ Name | Type
 `error` | [ErrorDetail](ErrorDetail.md)
 `data` | [Order](Order.md)
 
-## Example
-
-```typescript
-import type { CreateOrder200Response } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "success": true,
-  "error": null,
-  "data": null,
-} satisfies CreateOrder200Response
-
-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 CreateOrder200Response
-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)