pmxtjs 2.19.5 → 2.20.0

package/dist/pmxt/client.js

@@ -10,6 +10,7 @@ exports.Baozi = exports.Probable = exports.Myriad = exports.KalshiDemo = exports
 const index_js_1 = require("../generated/src/index.js");
 const models_js_1 = require("./models.js");
 const server_manager_js_1 = require("./server-manager.js");
+const args_js_1 = require("./args.js");
 // Converter functions
 function convertMarket(raw) {
     const outcomes = (raw.outcomes || []).map((o) => ({
@@ -146,6 +147,19 @@ function convertEvent(raw) {
     };
     return event;
 }
+function convertSubscriptionSnapshot(raw) {
+    const trades = (raw.trades ?? []).map(convertTrade);
+    const balances = (raw.balances ?? []).map(convertBalance);
+    const positions = (raw.positions ?? []).map(convertPosition);
+    const snapShot = {
+        address: raw.address,
+        trades,
+        balances,
+        positions,
+        timestamp: raw.timestamp,
+    };
+    return snapShot;
+}
 /**
  * Base class for prediction market exchanges.
  *
@@ -298,9 +312,7 @@ class Exchange {
     async fetchMarkets(params) {
         await this.initPromise;
         try {
-            const args = [];
-            if (params !== undefined)
-                args.push(params);
+            const args = (0, args_js_1.buildArgsWithOptionalOptions)(params);
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchMarkets`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -321,9 +333,7 @@ class Exchange {
     async fetchMarketsPaginated(params) {
         await this.initPromise;
         try {
-            const args = [];
-            if (params !== undefined)
-                args.push(params);
+            const args = (0, args_js_1.buildArgsWithOptionalOptions)(params);
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchMarketsPaginated`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -348,9 +358,7 @@ class Exchange {
     async fetchEvents(params) {
         await this.initPromise;
         try {
-            const args = [];
-            if (params !== undefined)
-                args.push(params);
+            const args = (0, args_js_1.buildArgsWithOptionalOptions)(params);
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchEvents`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -371,9 +379,7 @@ class Exchange {
     async fetchMarket(params) {
         await this.initPromise;
         try {
-            const args = [];
-            if (params !== undefined)
-                args.push(params);
+            const args = (0, args_js_1.buildArgsWithOptionalOptions)(params);
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchMarket`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -394,9 +400,7 @@ class Exchange {
     async fetchEvent(params) {
         await this.initPromise;
         try {
-            const args = [];
-            if (params !== undefined)
-                args.push(params);
+            const args = (0, args_js_1.buildArgsWithOptionalOptions)(params);
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchEvent`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -483,9 +487,7 @@ class Exchange {
     async fetchOpenOrders(marketId) {
         await this.initPromise;
         try {
-            const args = [];
-            if (marketId !== undefined)
-                args.push(marketId);
+            const args = (0, args_js_1.buildArgsWithOptionalOptions)(marketId);
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchOpenOrders`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -506,9 +508,7 @@ class Exchange {
     async fetchMyTrades(params) {
         await this.initPromise;
         try {
-            const args = [];
-            if (params !== undefined)
-                args.push(params);
+            const args = (0, args_js_1.buildArgsWithOptionalOptions)(params);
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchMyTrades`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -529,9 +529,7 @@ class Exchange {
     async fetchClosedOrders(params) {
         await this.initPromise;
         try {
-            const args = [];
-            if (params !== undefined)
-                args.push(params);
+            const args = (0, args_js_1.buildArgsWithOptionalOptions)(params);
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchClosedOrders`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -552,9 +550,7 @@ class Exchange {
     async fetchAllOrders(params) {
         await this.initPromise;
         try {
-            const args = [];
-            if (params !== undefined)
-                args.push(params);
+            const args = (0, args_js_1.buildArgsWithOptionalOptions)(params);
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchAllOrders`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -572,10 +568,10 @@ class Exchange {
             throw new Error(`Failed to fetchAllOrders: ${error}`);
         }
     }
-    async fetchPositions() {
+    async fetchPositions(address) {
         await this.initPromise;
         try {
-            const args = [];
+            const args = address ? [address] : [];
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchPositions`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -593,10 +589,10 @@ class Exchange {
             throw new Error(`Failed to fetchPositions: ${error}`);
         }
     }
-    async fetchBalance() {
+    async fetchBalance(address) {
         await this.initPromise;
         try {
-            const args = [];
+            const args = address ? [address] : [];
             const response = await fetch(`${this.config.basePath}/api/${this.exchangeName}/fetchBalance`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json', ...this.getAuthHeaders() },
@@ -761,6 +757,7 @@ class Exchange {
      * Call repeatedly in a loop to stream updates (CCXT Pro pattern).
      *
      * @param outcomeId - Outcome ID to watch
+     * @param address - Public wallet to be watched
      * @param since - Optional timestamp to filter trades from
      * @param limit - Optional limit for number of trades
      * @returns Next trade update(s)
@@ -776,10 +773,13 @@ class Exchange {
      * }
      * ```
      */
-    async watchTrades(outcomeId, since, limit) {
+    async watchTrades(outcomeId, address, since, limit) {
         await this.initPromise;
         try {
             const args = [outcomeId];
+            if (address !== undefined) {
+                args.push(address);
+            }
             if (since !== undefined) {
                 args.push(since);
             }
@@ -801,7 +801,191 @@ class Exchange {
             throw new Error(`Failed to watch trades: ${error}`);
         }
     }
+    /**
+     * Watch real-time updates of a public wallet via WebSocket.
+     *
+     * Returns a promise that resolves with the next update(s).
+     * Call repeatedly in a loop to stream updates (CCXT Pro pattern).
+     *
+     * @param address - Public wallet to be watched
+     * @param types - Subscription options including 'trades', 'positions', and 'balances'
+     * @returns Next update(s)
+     *
+     * @example
+     * ```typescript
+     * // Stream updates of a public wallet address
+     * while (true) {
+     *   const snapshots = await exchange.watchAddress(address, types);
+     *   for (const snapshot of snapshots) {
+     *     console.log(`Trade: ${snapshot.trades}`);
+     *   }
+     * }
+     * ```
+     */
+    async watchAddress(address, types) {
+        await this.initPromise;
+        try {
+            const args = [address];
+            if (types !== undefined) {
+                args.push(types);
+            }
+            const requestBody = {
+                args,
+                credentials: this.getCredentials()
+            };
+            const response = await this.api.watchAddress({
+                exchange: this.exchangeName,
+                watchAddressRequest: requestBody,
+            });
+            const data = this.handleResponse(response);
+            return convertSubscriptionSnapshot(data);
+        }
+        catch (error) {
+            throw new Error(`Failed to watch address: ${error}`);
+        }
+    }
+    /**
+     * Stop watching a previously registered wallet address and release its resource updates.
+     *
+     * @param address - Public wallet to be watched
+     * @returns
+     */
+    async unwatchAddress(address) {
+        await this.initPromise;
+        try {
+            const args = [address];
+            const requestBody = {
+                args,
+                credentials: this.getCredentials()
+            };
+            const response = await this.api.unwatchAddress({
+                exchange: this.exchangeName,
+                unwatchAddressRequest: requestBody,
+            });
+            return this.handleResponse(response);
+        }
+        catch (error) {
+            throw new Error(`Failed to unwatch address: ${error}`);
+        }
+    }
     // Trading Methods (require authentication)
+    /**
+     * Build an order payload without submitting it to the exchange.
+     * Returns the exchange-native signed order or transaction payload for
+     * inspection, forwarding through a middleware layer, or deferred
+     * submission via {@link submitOrder}.
+     *
+     * You can specify the market either with explicit marketId/outcomeId,
+     * or by passing an outcome object directly (e.g., market.yes).
+     *
+     * @param params - Order parameters (same as createOrder)
+     * @returns A BuiltOrder containing the exchange-native payload
+     *
+     * @example
+     * ```typescript
+     * // Build, inspect, then submit:
+     * const built = await exchange.buildOrder({
+     *   marketId: "663583",
+     *   outcomeId: "10991849...",
+     *   side: "buy",
+     *   type: "limit",
+     *   amount: 10,
+     *   price: 0.55
+     * });
+     *
+     * console.log(built.signedOrder); // inspect before submitting
+     * const order = await exchange.submitOrder(built);
+     *
+     * // Using outcome shorthand:
+     * const built2 = await exchange.buildOrder({
+     *   outcome: market.yes,
+     *   side: "buy",
+     *   type: "market",
+     *   amount: 10
+     * });
+     * ```
+     */
+    async buildOrder(params) {
+        await this.initPromise;
+        try {
+            let marketId = params.marketId;
+            let outcomeId = params.outcomeId;
+            if (params.outcome) {
+                if (marketId !== undefined || outcomeId !== undefined) {
+                    throw new Error("Cannot specify both 'outcome' and 'marketId'/'outcomeId'. Use one or the other.");
+                }
+                const outcome = params.outcome;
+                if (!outcome.marketId) {
+                    throw new Error("outcome.marketId is not set. Ensure the outcome comes from a fetched market.");
+                }
+                marketId = outcome.marketId;
+                outcomeId = outcome.outcomeId;
+            }
+            const paramsDict = {
+                marketId,
+                outcomeId,
+                side: params.side,
+                type: params.type,
+                amount: params.amount,
+            };
+            if (params.price !== undefined) {
+                paramsDict.price = params.price;
+            }
+            if (params.fee !== undefined) {
+                paramsDict.fee = params.fee;
+            }
+            const requestBody = {
+                args: [paramsDict],
+                credentials: this.getCredentials()
+            };
+            const response = await this.api.buildOrder({
+                exchange: this.exchangeName,
+                buildOrderRequest: requestBody,
+            });
+            const data = this.handleResponse(response);
+            return data;
+        }
+        catch (error) {
+            throw new Error(`Failed to build order: ${error}`);
+        }
+    }
+    /**
+     * Submit a pre-built order returned by {@link buildOrder}.
+     *
+     * @param built - The BuiltOrder payload from buildOrder()
+     * @returns The submitted order
+     *
+     * @example
+     * ```typescript
+     * const built = await exchange.buildOrder({
+     *   outcome: market.yes,
+     *   side: "buy",
+     *   type: "limit",
+     *   amount: 10,
+     *   price: 0.55
+     * });
+     * const order = await exchange.submitOrder(built);
+     * console.log(order.id, order.status);
+     * ```
+     */
+    async submitOrder(built) {
+        await this.initPromise;
+        try {
+            const requestBody = {
+                args: [built],
+                credentials: this.getCredentials()
+            };
+            const response = await this.api.submitOrder({
+                exchange: this.exchangeName,
+                submitOrderRequest: requestBody,
+            });
+            const data = this.handleResponse(response);
+            return convertOrder(data);
+        }
+        catch (error) {
+            throw new Error(`Failed to submit order: ${error}`);
+        }
+    }
     /**
      * Create a new order.
      *

package/dist/pmxt/models.d.ts

@@ -273,6 +273,26 @@ export interface CreateOrderParams {
     /** Optional fee rate (e.g., 1000 for 0.1%) */
     fee?: number;
 }
+/**
+ * An order payload built but not yet submitted to the exchange.
+ */
+export interface BuiltOrder {
+    /** The exchange name this order was built for. */
+    exchange: string;
+    /** The original params used to build this order. */
+    params: CreateOrderParams;
+    /** For CLOB exchanges (Polymarket): the EIP-712 signed order. */
+    signedOrder?: Record<string, unknown>;
+    /** For on-chain AMM exchanges: the EVM transaction payload. */
+    tx?: {
+        to: string;
+        data: string;
+        value: string;
+        chainId: number;
+    };
+    /** The raw, exchange-native payload. Always present. */
+    raw: unknown;
+}
 /**
  * A list of UnifiedMarket objects with a convenience match() method.
  * Extends Array so all standard array operations work unchanged.
@@ -393,3 +413,28 @@ export interface EventFilterCriteria {
  * Function type for custom event filtering logic.
  */
 export type EventFilterFunction = (event: UnifiedEvent) => boolean;
+/**
+ * Subscription options.
+ */
+export type SubscriptionOption = 'trades' | 'positions' | 'balances';
+/**
+ * Subscription snapshot of a watched public wallet address.
+ */
+export interface SubscribedAddressSnapshot {
+    /** The wallet address being watched */
+    address: string;
+    /** Recent trades for this address
+     * (if the above SubscriptionOption 'trades' option was requested)
+     */
+    trades?: Trade[];
+    /** Current open positions for this address
+     * (if the above SubscriptionOption 'positions' option was requested)
+     */
+    positions?: Position[];
+    /** Current balances for this address
+     * (if the above SubscriptionOption 'balances' option was requested)
+     */
+    balances?: Balance[];
+    /** Unix timestamp (ms) of this snapshot */
+    timestamp: number;
+}

package/generated/.openapi-generator/FILES

@@ -82,7 +82,11 @@ docs/Trade.md
 docs/TradesParams.md
 docs/UnifiedEvent.md
 docs/UnifiedMarket.md
+docs/UnwatchAddressRequest.md
 docs/UserTrade.md
+docs/WatchAddress200Response.md
+docs/WatchAddressRequest.md
+docs/WatchAddressRequestArgsInner.md
 docs/WatchOrderBookRequest.md
 docs/WatchOrderBookRequestArgsInner.md
 docs/WatchTradesRequest.md
@@ -169,7 +173,11 @@ src/models/Trade.ts
 src/models/TradesParams.ts
 src/models/UnifiedEvent.ts
 src/models/UnifiedMarket.ts
+src/models/UnwatchAddressRequest.ts
 src/models/UserTrade.ts
+src/models/WatchAddress200Response.ts
+src/models/WatchAddressRequest.ts
+src/models/WatchAddressRequestArgsInner.ts
 src/models/WatchOrderBookRequest.ts
 src/models/WatchOrderBookRequestArgsInner.ts
 src/models/WatchTradesRequest.ts

package/generated/docs/DefaultApi.md

@@ -30,6 +30,8 @@ All URIs are relative to *http://localhost:3847*
 | [**healthCheck**](DefaultApi.md#healthcheck) | **GET** /health | Server Health Check |
 | [**loadMarkets**](DefaultApi.md#loadmarketsoperation) | **POST** /api/{exchange}/loadMarkets | Load Markets |
 | [**submitOrder**](DefaultApi.md#submitorderoperation) | **POST** /api/{exchange}/submitOrder | Submit Order |
+| [**unwatchAddress**](DefaultApi.md#unwatchaddressoperation) | **POST** /api/{exchange}/unwatchAddress | Unwatch Address |
+| [**watchAddress**](DefaultApi.md#watchaddressoperation) | **POST** /api/{exchange}/watchAddress | Watch Address |
 | [**watchOrderBook**](DefaultApi.md#watchorderbookoperation) | **POST** /api/{exchange}/watchOrderBook | Watch Order Book |
 | [**watchTrades**](DefaultApi.md#watchtradesoperation) | **POST** /api/{exchange}/watchTrades | Watch Trades |
 
@@ -1836,6 +1838,146 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## unwatchAddress
+
+> BaseResponse unwatchAddress(exchange, unwatchAddressRequest)
+
+Unwatch Address
+
+Stop watching a previously registered wallet address and release its resource updates.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from 'pmxtjs';
+import type { UnwatchAddressOperationRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
+    exchange: exchange_example,
+    // UnwatchAddressRequest (optional)
+    unwatchAddressRequest: ...,
+  } satisfies UnwatchAddressOperationRequest;
+
+  try {
+    const data = await api.unwatchAddress(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
+| **unwatchAddressRequest** | [UnwatchAddressRequest](UnwatchAddressRequest.md) |  | [Optional] |
+
+### Return type
+
+[**BaseResponse**](BaseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Unwatch Address response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## watchAddress
+
+> WatchAddress200Response watchAddress(exchange, watchAddressRequest)
+
+Watch Address
+
+Stream activity for a public wallet address Returns a promise that resolves with the next activity snapshot whenever a change is detected. Call repeatedly in a loop to stream updates (CCXT Pro pattern).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from 'pmxtjs';
+import type { WatchAddressOperationRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
+    exchange: exchange_example,
+    // WatchAddressRequest (optional)
+    watchAddressRequest: ...,
+  } satisfies WatchAddressOperationRequest;
+
+  try {
+    const data = await api.watchAddress(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
+| **watchAddressRequest** | [WatchAddressRequest](WatchAddressRequest.md) |  | [Optional] |
+
+### Return type
+
+[**WatchAddress200Response**](WatchAddress200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Watch Address response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## watchOrderBook
 
 > FetchOrderBook200Response watchOrderBook(exchange, watchOrderBookRequest)

package/generated/docs/FetchBalanceRequest.md

@@ -6,7 +6,7 @@
 
 Name | Type
 ------------ | -------------
-`args` | Array<any>
+`args` | Array<string>
 `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
 
 ## Example

package/generated/docs/FetchPositionsRequest.md

@@ -6,7 +6,7 @@
 
 Name | Type
 ------------ | -------------
-`args` | Array<any>
+`args` | Array<string>
 `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
 
 ## Example

package/generated/docs/UnwatchAddressRequest.md

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

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