pmxtjs 2.49.0 → 2.49.1

package/dist/generated/src/models/index.d.ts

@@ -21,6 +21,7 @@ export * from './EventFilterCriteriaTotalVolume';
 export * from './EventMatchResult';
 export * from './ExchangeCredentials';
 export * from './ExchangeCredentialsSignatureType';
+export * from './ExchangeOptions';
 export * from './ExecutionPriceResult';
 export * from './FeedFetchHistoricalPrices200Response';
 export * from './FeedFetchOHLCV200Response';

package/dist/generated/src/models/index.js

@@ -39,6 +39,7 @@ __exportStar(require("./EventFilterCriteriaTotalVolume"), exports);
 __exportStar(require("./EventMatchResult"), exports);
 __exportStar(require("./ExchangeCredentials"), exports);
 __exportStar(require("./ExchangeCredentialsSignatureType"), exports);
+__exportStar(require("./ExchangeOptions"), exports);
 __exportStar(require("./ExecutionPriceResult"), exports);
 __exportStar(require("./FeedFetchHistoricalPrices200Response"), exports);
 __exportStar(require("./FeedFetchOHLCV200Response"), exports);

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/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.49.0",
+  "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'],
     };
 }
 

package/generated/src/models/ExchangeOptions.ts

@@ -0,0 +1,115 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi, Limitless). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation.
+ *
+ * The version of the OpenAPI document: 0.4.4
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 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.
+ * @export
+ * @interface ExchangeOptions
+ */
+export interface ExchangeOptions {
+    /**
+     * PMXT customer API key. When set, the SDK routes to api.pmxt.dev (catalog) and trade.pmxt.dev (trading). Get one at pmxt.dev/dashboard.
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    pmxtApiKey?: string;
+    /**
+     * EVM wallet address for hosted reads/writes. Required for endpoints that operate on a wallet (balances, positions, trades, open orders).
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    walletAddress?: string | null;
+    /**
+     * Optional pre-built signer for hosted writes. If absent and privateKey is set, the SDK auto-wraps privateKey into a signer.
+     * @type {object}
+     * @memberof ExchangeOptions
+     */
+    signer?: object | null;
+    /**
+     * Private key. In hosted mode, used to derive an EIP-712 signer for writes (wraps into EthAccountSigner/EthersSigner). In self-hosted mode, used as the venue credential directly.
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    privateKey?: string | null;
+    /**
+     * Explicit base URL override. When unset, the SDK uses api.pmxt.dev when pmxtApiKey is set, or the local sidecar otherwise.
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    baseUrl?: string | null;
+    /**
+     * Venue-side API key (e.g. Polymarket CLOB key). Only relevant for self-hosted mode.
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    apiKey?: string | null;
+    /**
+     * Auto-start the local sidecar when running self-hosted. Defaults to true when no pmxtApiKey is set, false when hosted.
+     * @type {boolean}
+     * @memberof ExchangeOptions
+     */
+    autoStartServer?: boolean | null;
+}
+
+/**
+ * Check if a given object implements the ExchangeOptions interface.
+ */
+export function instanceOfExchangeOptions(value: object): value is ExchangeOptions {
+    return true;
+}
+
+export function ExchangeOptionsFromJSON(json: any): ExchangeOptions {
+    return ExchangeOptionsFromJSONTyped(json, false);
+}
+
+export function ExchangeOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExchangeOptions {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pmxtApiKey': json['pmxtApiKey'] == null ? undefined : json['pmxtApiKey'],
+        'walletAddress': json['walletAddress'] == null ? undefined : json['walletAddress'],
+        'signer': json['signer'] == null ? undefined : json['signer'],
+        'privateKey': json['privateKey'] == null ? undefined : json['privateKey'],
+        'baseUrl': json['baseUrl'] == null ? undefined : json['baseUrl'],
+        'apiKey': json['apiKey'] == null ? undefined : json['apiKey'],
+        'autoStartServer': json['autoStartServer'] == null ? undefined : json['autoStartServer'],
+    };
+}
+
+export function ExchangeOptionsToJSON(json: any): ExchangeOptions {
+    return ExchangeOptionsToJSONTyped(json, false);
+}
+
+export function ExchangeOptionsToJSONTyped(value?: ExchangeOptions | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'pmxtApiKey': value['pmxtApiKey'],
+        'walletAddress': value['walletAddress'],
+        'signer': value['signer'],
+        'privateKey': value['privateKey'],
+        'baseUrl': value['baseUrl'],
+        'apiKey': value['apiKey'],
+        'autoStartServer': value['autoStartServer'],
+    };
+}
+

package/generated/src/models/MatchedMarketPair.ts

@@ -82,7 +82,7 @@ export interface MatchedMarketPair {
      */
     confidence?: number;
     /**
-     * 
+     * Why the two markets were matched.
      * @type {string}
      * @memberof MatchedMarketPair
      */

package/generated/src/models/Order.ts

@@ -103,6 +103,24 @@ export interface Order {
      * @memberof Order
      */
     feeRateBps?: number;
+    /**
+     * Populated in hosted mode after on-chain settlement; null for local-mode and for non-on-chain venues.
+     * @type {string}
+     * @memberof Order
+     */
+    txHash?: string | null;
+    /**
+     * Populated in hosted mode after on-chain settlement; null for local-mode and for non-on-chain venues.
+     * @type {string}
+     * @memberof Order
+     */
+    chain?: string | null;
+    /**
+     * Populated in hosted mode after on-chain settlement; null for local-mode and for non-on-chain venues.
+     * @type {number}
+     * @memberof Order
+     */
+    blockNumber?: number | null;
 }
 
 
@@ -178,6 +196,9 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
         'timestamp': json['timestamp'],
         'fee': json['fee'] == null ? undefined : json['fee'],
         'feeRateBps': json['feeRateBps'] == null ? undefined : json['feeRateBps'],
+        'txHash': json['txHash'] == null ? undefined : json['txHash'],
+        'chain': json['chain'] == null ? undefined : json['chain'],
+        'blockNumber': json['blockNumber'] == null ? undefined : json['blockNumber'],
     };
 }
 
@@ -206,6 +227,9 @@ export function OrderToJSONTyped(value?: Order | null, ignoreDiscriminator: bool
         'timestamp': value['timestamp'],
         'fee': value['fee'],
         'feeRateBps': value['feeRateBps'],
+        'txHash': value['txHash'],
+        'chain': value['chain'],
+        'blockNumber': value['blockNumber'],
     };
 }