pmxtjs 1.3.4 → 1.4.0

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

@@ -0,0 +1,22 @@
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi). 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 type { OrderBook } from './OrderBook';
+/**
+ * @type GetExecutionPriceRequestArgsInner
+ *
+ * @export
+ */
+export type GetExecutionPriceRequestArgsInner = OrderBook | number | string;
+export declare function GetExecutionPriceRequestArgsInnerFromJSON(json: any): GetExecutionPriceRequestArgsInner;
+export declare function GetExecutionPriceRequestArgsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetExecutionPriceRequestArgsInner;
+export declare function GetExecutionPriceRequestArgsInnerToJSON(json: any): any;
+export declare function GetExecutionPriceRequestArgsInnerToJSONTyped(value?: GetExecutionPriceRequestArgsInner | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi). 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetExecutionPriceRequestArgsInnerFromJSON = GetExecutionPriceRequestArgsInnerFromJSON;
+exports.GetExecutionPriceRequestArgsInnerFromJSONTyped = GetExecutionPriceRequestArgsInnerFromJSONTyped;
+exports.GetExecutionPriceRequestArgsInnerToJSON = GetExecutionPriceRequestArgsInnerToJSON;
+exports.GetExecutionPriceRequestArgsInnerToJSONTyped = GetExecutionPriceRequestArgsInnerToJSONTyped;
+const OrderBook_1 = require("./OrderBook");
+function GetExecutionPriceRequestArgsInnerFromJSON(json) {
+    return GetExecutionPriceRequestArgsInnerFromJSONTyped(json, false);
+}
+function GetExecutionPriceRequestArgsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json !== 'object') {
+        return json;
+    }
+    if ((0, OrderBook_1.instanceOfOrderBook)(json)) {
+        return (0, OrderBook_1.OrderBookFromJSONTyped)(json, true);
+    }
+    if (typeof json === 'number') {
+        return json;
+    }
+    if (typeof json === 'string' && (json === 'buy' || json === 'sell')) {
+        return json;
+    }
+    return {};
+}
+function GetExecutionPriceRequestArgsInnerToJSON(json) {
+    return GetExecutionPriceRequestArgsInnerToJSONTyped(json, false);
+}
+function GetExecutionPriceRequestArgsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value !== 'object') {
+        return value;
+    }
+    if ((0, OrderBook_1.instanceOfOrderBook)(value)) {
+        return (0, OrderBook_1.OrderBookToJSON)(value);
+    }
+    if (typeof value === 'number') {
+        return value;
+    }
+    if (typeof value === 'string' && (value === 'buy' || value === 'sell')) {
+        return value;
+    }
+    return {};
+}

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

@@ -8,6 +8,7 @@ export * from './CreateOrderRequest';
 export * from './ErrorDetail';
 export * from './ErrorResponse';
 export * from './ExchangeCredentials';
+export * from './ExecutionPriceResult';
 export * from './FetchBalance200Response';
 export * from './FetchMarkets200Response';
 export * from './FetchMarketsRequest';
@@ -22,6 +23,10 @@ export * from './FetchPositions200Response';
 export * from './FetchPositionsRequest';
 export * from './FetchTrades200Response';
 export * from './FetchTradesRequest';
+export * from './GetExecutionPrice200Response';
+export * from './GetExecutionPriceDetailed200Response';
+export * from './GetExecutionPriceRequest';
+export * from './GetExecutionPriceRequestArgsInner';
 export * from './GetMarketsBySlugRequest';
 export * from './HealthCheck200Response';
 export * from './HistoryFilterParams';

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

@@ -26,6 +26,7 @@ __exportStar(require("./CreateOrderRequest"), exports);
 __exportStar(require("./ErrorDetail"), exports);
 __exportStar(require("./ErrorResponse"), exports);
 __exportStar(require("./ExchangeCredentials"), exports);
+__exportStar(require("./ExecutionPriceResult"), exports);
 __exportStar(require("./FetchBalance200Response"), exports);
 __exportStar(require("./FetchMarkets200Response"), exports);
 __exportStar(require("./FetchMarketsRequest"), exports);
@@ -40,6 +41,10 @@ __exportStar(require("./FetchPositions200Response"), exports);
 __exportStar(require("./FetchPositionsRequest"), exports);
 __exportStar(require("./FetchTrades200Response"), exports);
 __exportStar(require("./FetchTradesRequest"), exports);
+__exportStar(require("./GetExecutionPrice200Response"), exports);
+__exportStar(require("./GetExecutionPriceDetailed200Response"), exports);
+__exportStar(require("./GetExecutionPriceRequest"), exports);
+__exportStar(require("./GetExecutionPriceRequestArgsInner"), exports);
 __exportStar(require("./GetMarketsBySlugRequest"), exports);
 __exportStar(require("./HealthCheck200Response"), exports);
 __exportStar(require("./HistoryFilterParams"), exports);

package/dist/pmxt/client.d.ts

@@ -5,7 +5,7 @@
  * OpenAPI client, matching the Python API exactly.
  */
 import { DefaultApi, Configuration, ExchangeCredentials } from "../generated/src/index.js";
-import { UnifiedMarket, PriceCandle, OrderBook, Trade, Order, Position, Balance, MarketFilterParams, HistoryFilterParams, CreateOrderParams, UnifiedEvent } from "./models.js";
+import { UnifiedMarket, PriceCandle, OrderBook, Trade, Order, Position, Balance, MarketFilterParams, HistoryFilterParams, CreateOrderParams, UnifiedEvent, ExecutionPriceResult } from "./models.js";
 import { ServerManager } from "./server-manager.js";
 /**
  * Base exchange client options.
@@ -234,6 +234,26 @@ export declare abstract class Exchange {
      * @returns List of balances (by currency)
      */
     fetchBalance(): Promise<Balance[]>;
+    /**
+     * Calculate the average execution price for a given amount by walking the order book.
+     * Uses the sidecar server for calculation to ensure consistency.
+     *
+     * @param orderBook - The current order book
+     * @param side - 'buy' or 'sell'
+     * @param amount - The amount to execute
+     * @returns The volume-weighted average price, or 0 if insufficient liquidity
+     */
+    getExecutionPrice(orderBook: OrderBook, side: 'buy' | 'sell', amount: number): Promise<number>;
+    /**
+     * Calculate detailed execution price information.
+     * Uses the sidecar server for calculation to ensure consistency.
+     *
+     * @param orderBook - The current order book
+     * @param side - 'buy' or 'sell'
+     * @param amount - The amount to execute
+     * @returns Detailed execution result
+     */
+    getExecutionPriceDetailed(orderBook: OrderBook, side: 'buy' | 'sell', amount: number): Promise<ExecutionPriceResult>;
 }
 /**
  * Polymarket exchange client.

package/dist/pmxt/client.js

@@ -735,6 +735,58 @@ class Exchange {
             throw new Error(`Failed to fetch balance: ${error}`);
         }
     }
+    /**
+     * Calculate the average execution price for a given amount by walking the order book.
+     * Uses the sidecar server for calculation to ensure consistency.
+     *
+     * @param orderBook - The current order book
+     * @param side - 'buy' or 'sell'
+     * @param amount - The amount to execute
+     * @returns The volume-weighted average price, or 0 if insufficient liquidity
+     */
+    async getExecutionPrice(orderBook, side, amount) {
+        const result = await this.getExecutionPriceDetailed(orderBook, side, amount);
+        return result.fullyFilled ? result.price : 0;
+    }
+    /**
+     * Calculate detailed execution price information.
+     * Uses the sidecar server for calculation to ensure consistency.
+     *
+     * @param orderBook - The current order book
+     * @param side - 'buy' or 'sell'
+     * @param amount - The amount to execute
+     * @returns Detailed execution result
+     */
+    async getExecutionPriceDetailed(orderBook, side, amount) {
+        await this.initPromise;
+        try {
+            const body = {
+                args: [orderBook, side, amount]
+            };
+            const credentials = this.getCredentials();
+            if (credentials) {
+                body.credentials = credentials;
+            }
+            const url = `${this.config.basePath}/api/${this.exchangeName}/getExecutionPriceDetailed`;
+            const response = await fetch(url, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    ...this.config.headers
+                },
+                body: JSON.stringify(body)
+            });
+            if (!response.ok) {
+                const error = await response.json().catch(() => ({}));
+                throw new Error(error.error?.message || response.statusText);
+            }
+            const json = await response.json();
+            return this.handleResponse(json);
+        }
+        catch (error) {
+            throw new Error(`Failed to get execution price: ${error}`);
+        }
+    }
 }
 exports.Exchange = Exchange;
 /**

package/dist/pmxt/models.d.ts

@@ -98,6 +98,17 @@ export interface OrderBook {
     /** Unix timestamp (milliseconds) */
     timestamp?: number;
 }
+/**
+ * Result of an execution price calculation.
+ */
+export interface ExecutionPriceResult {
+    /** The volume-weighted average price */
+    price: number;
+    /** The actual amount that can be filled */
+    filledAmount: number;
+    /** Whether the full requested amount can be filled */
+    fullyFilled: boolean;
+}
 /**
  * A historical trade.
  */

package/generated/.openapi-generator/FILES

@@ -12,6 +12,7 @@ docs/DefaultApi.md
 docs/ErrorDetail.md
 docs/ErrorResponse.md
 docs/ExchangeCredentials.md
+docs/ExecutionPriceResult.md
 docs/FetchBalance200Response.md
 docs/FetchMarkets200Response.md
 docs/FetchMarketsRequest.md
@@ -26,6 +27,10 @@ docs/FetchPositions200Response.md
 docs/FetchPositionsRequest.md
 docs/FetchTrades200Response.md
 docs/FetchTradesRequest.md
+docs/GetExecutionPrice200Response.md
+docs/GetExecutionPriceDetailed200Response.md
+docs/GetExecutionPriceRequest.md
+docs/GetExecutionPriceRequestArgsInner.md
 docs/GetMarketsBySlugRequest.md
 docs/HealthCheck200Response.md
 docs/HistoryFilterParams.md
@@ -60,6 +65,7 @@ src/models/CreateOrderRequest.ts
 src/models/ErrorDetail.ts
 src/models/ErrorResponse.ts
 src/models/ExchangeCredentials.ts
+src/models/ExecutionPriceResult.ts
 src/models/FetchBalance200Response.ts
 src/models/FetchMarkets200Response.ts
 src/models/FetchMarketsRequest.ts
@@ -74,6 +80,10 @@ src/models/FetchPositions200Response.ts
 src/models/FetchPositionsRequest.ts
 src/models/FetchTrades200Response.ts
 src/models/FetchTradesRequest.ts
+src/models/GetExecutionPrice200Response.ts
+src/models/GetExecutionPriceDetailed200Response.ts
+src/models/GetExecutionPriceRequest.ts
+src/models/GetExecutionPriceRequestArgsInner.ts
 src/models/GetMarketsBySlugRequest.ts
 src/models/HealthCheck200Response.ts
 src/models/HistoryFilterParams.ts

package/generated/docs/DefaultApi.md

@@ -14,6 +14,8 @@ All URIs are relative to *http://localhost:3847*
 | [**fetchOrderBook**](DefaultApi.md#fetchorderbookoperation) | **POST** /api/{exchange}/fetchOrderBook | Fetch Order Book |
 | [**fetchPositions**](DefaultApi.md#fetchpositionsoperation) | **POST** /api/{exchange}/fetchPositions | Fetch Positions |
 | [**fetchTrades**](DefaultApi.md#fetchtradesoperation) | **POST** /api/{exchange}/fetchTrades | Fetch Trades |
+| [**getExecutionPrice**](DefaultApi.md#getexecutionpriceoperation) | **POST** /api/{exchange}/getExecutionPrice | Get Execution Price |
+| [**getExecutionPriceDetailed**](DefaultApi.md#getexecutionpricedetailed) | **POST** /api/{exchange}/getExecutionPriceDetailed | Get Detailed Execution Price |
 | [**getMarketsBySlug**](DefaultApi.md#getmarketsbyslugoperation) | **POST** /api/{exchange}/getMarketsBySlug | Get Market by Slug |
 | [**healthCheck**](DefaultApi.md#healthcheck) | **GET** /health | Server Health Check |
 | [**searchEvents**](DefaultApi.md#searcheventsoperation) | **POST** /api/{exchange}/searchEvents | Search Events |
@@ -703,6 +705,142 @@ 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)
 
 
+## getExecutionPrice
+
+> GetExecutionPrice200Response getExecutionPrice(exchange, getExecutionPriceRequest)
+
+Get Execution Price
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from 'pmxtjs';
+import type { GetExecutionPriceOperationRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // 'polymarket' | 'kalshi' | The prediction market exchange to target.
+    exchange: exchange_example,
+    // GetExecutionPriceRequest (optional)
+    getExecutionPriceRequest: ...,
+  } satisfies GetExecutionPriceOperationRequest;
+
+  try {
+    const data = await api.getExecutionPrice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **exchange** | `polymarket`, `kalshi` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi] |
+| **getExecutionPriceRequest** | [GetExecutionPriceRequest](GetExecutionPriceRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GetExecutionPrice200Response**](GetExecutionPrice200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Average execution price |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getExecutionPriceDetailed
+
+> GetExecutionPriceDetailed200Response getExecutionPriceDetailed(exchange, getExecutionPriceRequest)
+
+Get Detailed Execution Price
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from 'pmxtjs';
+import type { GetExecutionPriceDetailedRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // 'polymarket' | 'kalshi' | The prediction market exchange to target.
+    exchange: exchange_example,
+    // GetExecutionPriceRequest (optional)
+    getExecutionPriceRequest: ...,
+  } satisfies GetExecutionPriceDetailedRequest;
+
+  try {
+    const data = await api.getExecutionPriceDetailed(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **exchange** | `polymarket`, `kalshi` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi] |
+| **getExecutionPriceRequest** | [GetExecutionPriceRequest](GetExecutionPriceRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GetExecutionPriceDetailed200Response**](GetExecutionPriceDetailed200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Detailed execution result |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getMarketsBySlug
 
 > FetchMarkets200Response getMarketsBySlug(exchange, getMarketsBySlugRequest)

package/generated/docs/ExecutionPriceResult.md

@@ -0,0 +1,38 @@
+
+# ExecutionPriceResult
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`price` | number
+`filledAmount` | number
+`fullyFilled` | boolean
+
+## Example
+
+```typescript
+import type { ExecutionPriceResult } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "price": null,
+  "filledAmount": null,
+  "fullyFilled": null,
+} satisfies ExecutionPriceResult
+
+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 ExecutionPriceResult
+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/GetExecutionPrice200Response.md

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

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

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

@@ -0,0 +1,38 @@
+
+# GetExecutionPriceRequestArgsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`bids` | [Array<OrderLevel>](OrderLevel.md)
+`asks` | [Array<OrderLevel>](OrderLevel.md)
+`timestamp` | number
+
+## Example
+
+```typescript
+import type { GetExecutionPriceRequestArgsInner } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "bids": null,
+  "asks": null,
+  "timestamp": null,
+} satisfies GetExecutionPriceRequestArgsInner
+
+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 GetExecutionPriceRequestArgsInner
+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": "1.3.4",
+  "version": "1.4.0",
   "description": "OpenAPI client for pmxtjs",
   "author": "OpenAPI-Generator",
   "repository": {