pmxtjs 2.48.6 → 2.49.1

package/dist/pmxt/models.d.ts

@@ -164,6 +164,12 @@ export interface UserTrade {
     outcomeId?: string;
     /** Market ID */
     marketId?: string;
+    /** On-chain transaction hash (populated in hosted mode when the trade was settled on-chain). */
+    txHash?: string;
+    /** Chain identifier (e.g. 'polygon'). Populated in hosted mode. */
+    chain?: string;
+    /** On-chain block number where this trade was included. Populated in hosted mode. */
+    blockNumber?: number;
 }
 /**
  * Result of a paginated market fetch.
@@ -222,6 +228,8 @@ export interface Order {
     status: string;
     /** Amount filled */
     filled: number;
+    /** Amount filled in shares/contracts (if different from USDC-denominated `filled`). */
+    filledShares?: number;
     /** Amount remaining */
     remaining: number;
     /** Unix timestamp (milliseconds) */
@@ -230,6 +238,14 @@ export interface Order {
     price?: number;
     /** Trading fee */
     fee?: number;
+    /** Fee rate in basis points applied to this order (e.g. 100 = 1%). */
+    feeRateBps?: number;
+    /** On-chain transaction hash (populated in hosted mode when the order was settled on-chain). */
+    txHash?: string;
+    /** Chain identifier (e.g. 'polygon'). Populated in hosted mode. */
+    chain?: string;
+    /** On-chain block number where this order was included. Populated in hosted mode. */
+    blockNumber?: number;
 }
 /**
  * A current position in a market.
@@ -239,18 +255,24 @@ export interface Position {
     marketId: string;
     /** Outcome ID */
     outcomeId: string;
-    /** Outcome label */
-    outcomeLabel: string;
+    /** Outcome label (populated in venue-direct mode; may be undefined in hosted mode when the server hasn't enriched). */
+    outcomeLabel?: string;
     /** Position size (positive for long, negative for short) */
     size: number;
-    /** Average entry price */
-    entryPrice: number;
-    /** Current market price */
-    currentPrice: number;
-    /** Unrealized profit/loss */
-    unrealizedPnL: number;
+    /** Average entry price (populated in venue-direct mode; may be undefined in hosted mode when the server hasn't enriched). */
+    entryPrice?: number;
+    /** Current market price (populated in venue-direct mode; may be undefined in hosted mode when the server hasn't enriched). */
+    currentPrice?: number;
+    /** Unrealized profit/loss (populated in venue-direct mode; may be undefined in hosted mode when the server hasn't enriched). */
+    unrealizedPnL?: number;
     /** Realized profit/loss */
     realizedPnL?: number;
+    /** On-chain transaction hash for the latest position update. Populated in hosted mode. */
+    txHash?: string;
+    /** Chain identifier (e.g. 'polygon'). Populated in hosted mode. */
+    chain?: string;
+    /** On-chain block number for the latest position update. Populated in hosted mode. */
+    blockNumber?: number;
 }
 /**
  * Account balance.
@@ -264,6 +286,12 @@ export interface Balance {
     available: number;
     /** Locked in open orders */
     locked: number;
+    /** On-chain transaction hash for the latest balance update. Populated in hosted mode. */
+    txHash?: string;
+    /** Chain identifier (e.g. 'polygon'). Populated in hosted mode. */
+    chain?: string;
+    /** On-chain block number for the latest balance update. Populated in hosted mode. */
+    blockNumber?: number;
 }
 /**
  * Candle interval for OHLCV data.
@@ -322,6 +350,8 @@ export interface EventFetchParams {
     limit?: number;
     /** Pagination offset */
     offset?: number;
+    /** Opaque venue pagination cursor, where supported. */
+    cursor?: string;
     /** Sort order */
     sort?: SortOption;
     /** Filter by event status */
@@ -332,6 +362,8 @@ export interface EventFetchParams {
     eventId?: string;
     /** Lookup by event slug */
     slug?: string;
+    /** Filter events by their parent series. Accepts the venue-native series id / ticker / slug. */
+    series?: string;
     /** Filter by event category (e.g. "sports", "politics", "crypto") */
     category?: string;
     /** Filter by tags attached to the event */
@@ -370,6 +402,12 @@ export interface CreateOrderParams {
     price?: number;
     /** Optional fee rate (e.g., 1000 for 0.1%) */
     fee?: number;
+    /** Optional override for Limitless/Polymarket */
+    tickSize?: number;
+    /** Optional override to skip neg-risk lookup (Polymarket) */
+    negRisk?: boolean;
+    /** Limitless delegated signing: profile ID to trade on behalf of */
+    onBehalfOf?: number;
 }
 /** Alias matching the core MarketFetchParams name. */
 export type MarketFetchParams = MarketFilterParams;

package/dist/pmxt/server-manager.d.ts

@@ -36,6 +36,10 @@ export declare class ServerManager {
      * Check if the server is running.
      */
     isServerRunning(): Promise<boolean>;
+    /**
+     * Backwards-compatible alias for `isServerRunning()`.
+     */
+    isServerAlive(): Promise<boolean>;
     /**
      * Wait for the server to be ready.
      * Requires a lock file to be present to avoid falsely matching an unrelated

package/dist/pmxt/server-manager.js

@@ -134,6 +134,12 @@ class ServerManager {
             return false;
         }
     }
+    /**
+     * Backwards-compatible alias for `isServerRunning()`.
+     */
+    async isServerAlive() {
+        return this.isServerRunning();
+    }
     /**
      * Wait for the server to be ready.
      * Requires a lock file to be present to avoid falsely matching an unrelated

package/dist/pmxt/signers.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Signer helpers for hosted PMXT trading.
+ *
+ * `ethers` is an optional peer dependency — read-only SDK users do not need it
+ * installed. Hosted-mode signing imports it lazily via `require()` and throws
+ * a clear install hint when it's missing.
+ *
+ * Mirrors `sdks/python/pmxt/signers.py`.
+ */
+/**
+ * EIP-712 typed data payload as accepted by ethers v6 / Web3 wallets.
+ * `EIP712Domain` is allowed inside `types` (and is the standard) but ethers
+ * strips it before signing — see {@link EthersSigner.signTypedData}.
+ */
+export interface TypedData {
+    types: Record<string, Array<{
+        name: string;
+        type: string;
+    }>>;
+    primaryType: string;
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    };
+    message: Record<string, unknown>;
+}
+/**
+ * Pluggable signer abstraction. Implement this to integrate hardware wallets
+ * or remote signing services. {@link EthersSigner} is the built-in
+ * private-key implementation.
+ */
+export interface Signer {
+    readonly address: string;
+    signTypedData(typedData: TypedData): Promise<string>;
+}
+/**
+ * Built-in signer backed by an ethers `Wallet`.
+ *
+ * `ethers` is imported lazily — a clear, install-hint-bearing error is thrown
+ * if the peer dependency is missing.
+ */
+export declare class EthersSigner implements Signer {
+    private readonly _wallet;
+    readonly address: string;
+    constructor(privateKey: string);
+    signTypedData(typedData: TypedData): Promise<string>;
+}
+/**
+ * Convenience factory: build a {@link Signer} from a raw private key.
+ *
+ * Currently always returns an {@link EthersSigner}. Async for forward
+ * compatibility with key-loaders that may need to await (e.g. keystore
+ * decryption).
+ */
+export declare function signerFromPrivateKey(privateKey: string): Promise<Signer>;

package/dist/pmxt/signers.js

@@ -0,0 +1,55 @@
+"use strict";
+/**
+ * Signer helpers for hosted PMXT trading.
+ *
+ * `ethers` is an optional peer dependency — read-only SDK users do not need it
+ * installed. Hosted-mode signing imports it lazily via `require()` and throws
+ * a clear install hint when it's missing.
+ *
+ * Mirrors `sdks/python/pmxt/signers.py`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EthersSigner = void 0;
+exports.signerFromPrivateKey = signerFromPrivateKey;
+const ETHERS_INSTALL_HINT = "hosted trading requires the optional 'ethers' peer dependency. Install with: npm install ethers";
+/**
+ * Built-in signer backed by an ethers `Wallet`.
+ *
+ * `ethers` is imported lazily — a clear, install-hint-bearing error is thrown
+ * if the peer dependency is missing.
+ */
+class EthersSigner {
+    _wallet; // ethers.Wallet
+    address;
+    constructor(privateKey) {
+        let ethers;
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-require-imports
+            ethers = require("ethers");
+        }
+        catch {
+            throw new Error(ETHERS_INSTALL_HINT);
+        }
+        this._wallet = new ethers.Wallet(privateKey);
+        this.address = this._wallet.address;
+    }
+    async signTypedData(typedData) {
+        // ethers expects `types` WITHOUT the EIP712Domain entry — it derives
+        // the domain hash from the `domain` argument.
+        const types = { ...typedData.types };
+        delete types["EIP712Domain"];
+        const sig = await this._wallet.signTypedData(typedData.domain, types, typedData.message);
+        return sig.startsWith("0x") ? sig : "0x" + sig;
+    }
+}
+exports.EthersSigner = EthersSigner;
+/**
+ * Convenience factory: build a {@link Signer} from a raw private key.
+ *
+ * Currently always returns an {@link EthersSigner}. Async for forward
+ * compatibility with key-loaders that may need to await (e.g. keystore
+ * decryption).
+ */
+async function signerFromPrivateKey(privateKey) {
+    return new EthersSigner(privateKey);
+}

package/dist/pmxt/ws-client.js

@@ -10,6 +10,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SidecarWsClient = void 0;
 const errors_js_1 = require("./errors.js");
+const logger_js_1 = require("./logger.js");
 const MAX_QUEUED_MESSAGES_PER_SUBSCRIPTION = 100_000;
 /**
  * Multiplexed WebSocket client for the pmxt sidecar.
@@ -120,7 +121,7 @@ class SidecarWsClient {
                 }
                 catch (err) {
                     // Dispatch bug -- log and continue; don't kill the connection.
-                    console.error('[SidecarWsClient] dispatch error:', err);
+                    logger_js_1.logger.error('[SidecarWsClient] dispatch error:', { err });
                 }
             };
         });

package/generated/.openapi-generator/FILES

@@ -27,6 +27,7 @@ docs/EventFilterCriteriaTotalVolume.md
 docs/EventMatchResult.md
 docs/ExchangeCredentials.md
 docs/ExchangeCredentialsSignatureType.md
+docs/ExchangeOptions.md
 docs/ExecutionPriceResult.md
 docs/FeedFetchHistoricalPrices200Response.md
 docs/FeedFetchOHLCV200Response.md
@@ -136,6 +137,7 @@ src/models/EventFilterCriteriaTotalVolume.ts
 src/models/EventMatchResult.ts
 src/models/ExchangeCredentials.ts
 src/models/ExchangeCredentialsSignatureType.ts
+src/models/ExchangeOptions.ts
 src/models/ExecutionPriceResult.ts
 src/models/FeedFetchHistoricalPrices200Response.ts
 src/models/FeedFetchOHLCV200Response.ts

package/generated/docs/Balance.md

@@ -10,6 +10,7 @@ Name | Type
 `total` | number
 `available` | number
 `locked` | number
+`venue` | string
 
 ## Example
 
@@ -22,6 +23,7 @@ const example = {
   "total": null,
   "available": null,
   "locked": null,
+  "venue": null,
 } satisfies Balance
 
 console.log(example)

package/generated/docs/BuiltOrder.md

@@ -11,6 +11,7 @@ Name | Type
 `signedOrder` | { [key: string]: any; }
 `tx` | [BuiltOrderTx](BuiltOrderTx.md)
 `raw` | any
+`expiry` | number
 
 ## Example
 
@@ -24,6 +25,7 @@ const example = {
   "signedOrder": null,
   "tx": null,
   "raw": null,
+  "expiry": null,
 } satisfies BuiltOrder
 
 console.log(example)

package/generated/docs/ErrorDetail.md

@@ -1,12 +1,17 @@
 
 # ErrorDetail
 
+Structured error envelope returned inside `BaseResponse.error` and `ErrorResponse.error`. Hosted-mode endpoints populate `code`, `retryable`, and optionally `exchange` / `detail`; legacy local-mode endpoints may still return only `message`.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `message` | string
+`code` | string
+`retryable` | boolean
+`exchange` | string
+`detail` | { [key: string]: any; }
 
 ## Example
 
@@ -16,6 +21,10 @@ import type { ErrorDetail } from 'pmxtjs'
 // TODO: Update the object below with actual values
 const example = {
   "message": null,
+  "code": null,
+  "retryable": null,
+  "exchange": null,
+  "detail": null,
 } satisfies ErrorDetail
 
 console.log(example)

package/generated/docs/ExchangeOptions.md

@@ -0,0 +1,47 @@
+
+# ExchangeOptions
+
+Constructor-level options for venue clients (Polymarket, Kalshi, Opinion, etc.). Hosted mode is the default when pmxtApiKey is set; otherwise the SDK runs against a local sidecar with venue credentials.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pmxtApiKey` | string
+`walletAddress` | string
+`signer` | object
+`privateKey` | string
+`baseUrl` | string
+`apiKey` | string
+`autoStartServer` | boolean
+
+## Example
+
+```typescript
+import type { ExchangeOptions } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pmxtApiKey": null,
+  "walletAddress": null,
+  "signer": null,
+  "privateKey": null,
+  "baseUrl": null,
+  "apiKey": null,
+  "autoStartServer": null,
+} satisfies ExchangeOptions
+
+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 ExchangeOptions
+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/Order.md

@@ -20,6 +20,9 @@ Name | Type
 `timestamp` | number
 `fee` | number
 `feeRateBps` | number
+`txHash` | string
+`chain` | string
+`blockNumber` | number
 
 ## Example
 
@@ -42,6 +45,9 @@ const example = {
   "timestamp": null,
   "fee": null,
   "feeRateBps": null,
+  "txHash": null,
+  "chain": null,
+  "blockNumber": null,
 } satisfies Order
 
 console.log(example)

package/generated/docs/OrderLevel.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `price` | number
 `size` | number
+`orderCount` | number
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { OrderLevel } from 'pmxtjs'
 const example = {
   "price": null,
   "size": null,
+  "orderCount": null,
 } satisfies OrderLevel
 
 console.log(example)

package/generated/docs/Position.md

@@ -1,6 +1,7 @@
 
 # Position
 
+A current position in a market. In hosted mode, `outcomeLabel`, `entryPrice`, `currentPrice` and `unrealizedPnL` may be null when the server cannot derive them (e.g. `with_mtm=false` or no fill history). Venue-direct callers continue to populate every field.
 
 ## Properties
 
@@ -12,8 +13,12 @@ Name | Type
 `size` | number
 `entryPrice` | number
 `currentPrice` | number
+`currentValue` | number
 `unrealizedPnL` | number
 `realizedPnL` | number
+`txHash` | string
+`chain` | string
+`blockNumber` | number
 
 ## Example
 
@@ -28,8 +33,12 @@ const example = {
   "size": null,
   "entryPrice": null,
   "currentPrice": null,
+  "currentValue": null,
   "unrealizedPnL": null,
   "realizedPnL": null,
+  "txHash": null,
+  "chain": null,
+  "blockNumber": null,
 } satisfies Position
 
 console.log(example)

package/generated/docs/UserTrade.md

@@ -13,6 +13,9 @@ Name | Type
 `side` | string
 `outcomeId` | string
 `orderId` | string
+`txHash` | string
+`chain` | string
+`blockNumber` | number
 
 ## Example
 
@@ -28,6 +31,9 @@ const example = {
   "side": null,
   "outcomeId": null,
   "orderId": null,
+  "txHash": null,
+  "chain": null,
+  "blockNumber": null,
 } satisfies UserTrade
 
 console.log(example)

package/generated/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "2.48.6",
+  "version": "2.49.1",
   "description": "OpenAPI client for pmxtjs",
   "author": "OpenAPI-Generator",
   "repository": {

package/generated/src/models/Balance.ts

@@ -43,6 +43,12 @@ export interface Balance {
      * @memberof Balance
      */
     locked: number;
+    /**
+     * Hosted-mode: which venue this balance belongs to in a multi-venue response. Null when the balance is venue-agnostic.
+     * @type {string}
+     * @memberof Balance
+     */
+    venue?: string | null;
 }
 
 /**
@@ -70,6 +76,7 @@ export function BalanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): B
         'total': json['total'],
         'available': json['available'],
         'locked': json['locked'],
+        'venue': json['venue'] == null ? undefined : json['venue'],
     };
 }
 
@@ -88,6 +95,7 @@ export function BalanceToJSONTyped(value?: Balance | null, ignoreDiscriminator:
         'total': value['total'],
         'available': value['available'],
         'locked': value['locked'],
+        'venue': value['venue'],
     };
 }
 

package/generated/src/models/BuiltOrder.ts

@@ -64,6 +64,12 @@ export interface BuiltOrder {
      * @memberof BuiltOrder
      */
     raw: any | null;
+    /**
+     * Unix epoch (ms) when this built order expires server-side. Submitting after expiry returns BUILT_ORDER_EXPIRED.
+     * @type {number}
+     * @memberof BuiltOrder
+     */
+    expiry?: number | null;
 }
 
 /**
@@ -91,6 +97,7 @@ export function BuiltOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'signedOrder': json['signedOrder'] == null ? undefined : json['signedOrder'],
         'tx': json['tx'] == null ? undefined : BuiltOrderTxFromJSON(json['tx']),
         'raw': json['raw'],
+        'expiry': json['expiry'] == null ? undefined : json['expiry'],
     };
 }
 
@@ -110,6 +117,7 @@ export function BuiltOrderToJSONTyped(value?: BuiltOrder | null, ignoreDiscrimin
         'signedOrder': value['signedOrder'],
         'tx': BuiltOrderTxToJSON(value['tx']),
         'raw': value['raw'],
+        'expiry': value['expiry'],
     };
 }
 

package/generated/src/models/ErrorDetail.ts

@@ -14,19 +14,76 @@
 
 import { mapValues } from '../runtime';
 /**
- * 
+ * Structured error envelope returned inside `BaseResponse.error` and `ErrorResponse.error`. Hosted-mode endpoints populate `code`, `retryable`, and optionally `exchange` / `detail`; legacy local-mode endpoints may still return only `message`.
  * @export
  * @interface ErrorDetail
  */
 export interface ErrorDetail {
     /**
-     * 
+     * Human-readable error message.
      * @type {string}
      * @memberof ErrorDetail
      */
     message?: string;
+    /**
+     * Stable machine-readable error code. Hosted-mode errors use the `HostedTradingError` family (e.g. `INSUFFICIENT_ESCROW_BALANCE`, `BUILT_ORDER_EXPIRED`); pre-hosted local errors use the legacy family (e.g. `BAD_REQUEST`, `NOT_FOUND`).
+     * @type {string}
+     * @memberof ErrorDetail
+     */
+    code?: ErrorDetailCodeEnum;
+    /**
+     * Hint for clients: when `true`, the same request may succeed on retry (e.g. transient network or rate-limit conditions); when `false`, the caller should not retry without modifying the request.
+     * @type {boolean}
+     * @memberof ErrorDetail
+     */
+    retryable?: boolean;
+    /**
+     * Venue the error originated from, when known (e.g. 'polymarket', 'kalshi').
+     * @type {string}
+     * @memberof ErrorDetail
+     */
+    exchange?: string | null;
+    /**
+     * Free-form hosted-mode detail blob. Shape depends on `code` — e.g. for `INSUFFICIENT_ESCROW_BALANCE` it may include `{ requested, available }`; for `ORDER_SIZE_TOO_SMALL` it may include `{ min }`; for `BUILT_ORDER_EXPIRED` it may include `{ expiry }`.
+     * @type {{ [key: string]: any; }}
+     * @memberof ErrorDetail
+     */
+    detail?: { [key: string]: any; } | null;
 }
 
+
+/**
+ * @export
+ */
+export const ErrorDetailCodeEnum = {
+    HostedTradingError: 'HOSTED_TRADING_ERROR',
+    InsufficientEscrowBalance: 'INSUFFICIENT_ESCROW_BALANCE',
+    OrderSizeTooSmall: 'ORDER_SIZE_TOO_SMALL',
+    InvalidApiKey: 'INVALID_API_KEY',
+    OutcomeNotFound: 'OUTCOME_NOT_FOUND',
+    CatalogUnavailable: 'CATALOG_UNAVAILABLE',
+    BuiltOrderExpired: 'BUILT_ORDER_EXPIRED',
+    InvalidSignature: 'INVALID_SIGNATURE',
+    NoLiquidity: 'NO_LIQUIDITY',
+    MissingWalletAddress: 'MISSING_WALLET_ADDRESS',
+    BadRequest: 'BAD_REQUEST',
+    AuthenticationError: 'AUTHENTICATION_ERROR',
+    PermissionDenied: 'PERMISSION_DENIED',
+    NotFound: 'NOT_FOUND',
+    OrderNotFound: 'ORDER_NOT_FOUND',
+    MarketNotFound: 'MARKET_NOT_FOUND',
+    EventNotFound: 'EVENT_NOT_FOUND',
+    RateLimitExceeded: 'RATE_LIMIT_EXCEEDED',
+    InvalidOrder: 'INVALID_ORDER',
+    InsufficientFunds: 'INSUFFICIENT_FUNDS',
+    ValidationError: 'VALIDATION_ERROR',
+    NetworkError: 'NETWORK_ERROR',
+    ExchangeNotAvailable: 'EXCHANGE_NOT_AVAILABLE',
+    NotSupported: 'NOT_SUPPORTED'
+} as const;
+export type ErrorDetailCodeEnum = typeof ErrorDetailCodeEnum[keyof typeof ErrorDetailCodeEnum];
+
+
 /**
  * Check if a given object implements the ErrorDetail interface.
  */
@@ -45,6 +102,10 @@ export function ErrorDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean
     return {
         
         'message': json['message'] == null ? undefined : json['message'],
+        'code': json['code'] == null ? undefined : json['code'],
+        'retryable': json['retryable'] == null ? undefined : json['retryable'],
+        'exchange': json['exchange'] == null ? undefined : json['exchange'],
+        'detail': json['detail'] == null ? undefined : json['detail'],
     };
 }
 
@@ -60,6 +121,10 @@ export function ErrorDetailToJSONTyped(value?: ErrorDetail | null, ignoreDiscrim
     return {
         
         'message': value['message'],
+        'code': value['code'],
+        'retryable': value['retryable'],
+        'exchange': value['exchange'],
+        'detail': value['detail'],
     };
 }