pmxtjs 1.3.3 → 1.4.0

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.3",
+  "version": "1.4.0",
   "description": "OpenAPI client for pmxtjs",
   "author": "OpenAPI-Generator",
   "repository": {

package/generated/src/apis/DefaultApi.ts

@@ -31,6 +31,9 @@ import type {
   FetchPositionsRequest,
   FetchTrades200Response,
   FetchTradesRequest,
+  GetExecutionPrice200Response,
+  GetExecutionPriceDetailed200Response,
+  GetExecutionPriceRequest,
   GetMarketsBySlugRequest,
   HealthCheck200Response,
   SearchEvents200Response,
@@ -72,6 +75,12 @@ import {
     FetchTrades200ResponseToJSON,
     FetchTradesRequestFromJSON,
     FetchTradesRequestToJSON,
+    GetExecutionPrice200ResponseFromJSON,
+    GetExecutionPrice200ResponseToJSON,
+    GetExecutionPriceDetailed200ResponseFromJSON,
+    GetExecutionPriceDetailed200ResponseToJSON,
+    GetExecutionPriceRequestFromJSON,
+    GetExecutionPriceRequestToJSON,
     GetMarketsBySlugRequestFromJSON,
     GetMarketsBySlugRequestToJSON,
     HealthCheck200ResponseFromJSON,
@@ -138,6 +147,16 @@ export interface FetchTradesOperationRequest {
     fetchTradesRequest?: FetchTradesRequest;
 }
 
+export interface GetExecutionPriceOperationRequest {
+    exchange: GetExecutionPriceOperationExchangeEnum;
+    getExecutionPriceRequest?: GetExecutionPriceRequest;
+}
+
+export interface GetExecutionPriceDetailedRequest {
+    exchange: GetExecutionPriceDetailedExchangeEnum;
+    getExecutionPriceRequest?: GetExecutionPriceRequest;
+}
+
 export interface GetMarketsBySlugOperationRequest {
     exchange: GetMarketsBySlugOperationExchangeEnum;
     getMarketsBySlugRequest?: GetMarketsBySlugRequest;
@@ -568,6 +587,86 @@ export class DefaultApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get Execution Price
+     */
+    async getExecutionPriceRaw(requestParameters: GetExecutionPriceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExecutionPrice200Response>> {
+        if (requestParameters['exchange'] == null) {
+            throw new runtime.RequiredError(
+                'exchange',
+                'Required parameter "exchange" was null or undefined when calling getExecutionPrice().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/{exchange}/getExecutionPrice`;
+        urlPath = urlPath.replace(`{${"exchange"}}`, encodeURIComponent(String(requestParameters['exchange'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetExecutionPriceRequestToJSON(requestParameters['getExecutionPriceRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetExecutionPrice200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get Execution Price
+     */
+    async getExecutionPrice(requestParameters: GetExecutionPriceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExecutionPrice200Response> {
+        const response = await this.getExecutionPriceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get Detailed Execution Price
+     */
+    async getExecutionPriceDetailedRaw(requestParameters: GetExecutionPriceDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExecutionPriceDetailed200Response>> {
+        if (requestParameters['exchange'] == null) {
+            throw new runtime.RequiredError(
+                'exchange',
+                'Required parameter "exchange" was null or undefined when calling getExecutionPriceDetailed().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/{exchange}/getExecutionPriceDetailed`;
+        urlPath = urlPath.replace(`{${"exchange"}}`, encodeURIComponent(String(requestParameters['exchange'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetExecutionPriceRequestToJSON(requestParameters['getExecutionPriceRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetExecutionPriceDetailed200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get Detailed Execution Price
+     */
+    async getExecutionPriceDetailed(requestParameters: GetExecutionPriceDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExecutionPriceDetailed200Response> {
+        const response = await this.getExecutionPriceDetailedRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get Market by Slug
      */
@@ -887,6 +986,22 @@ export const FetchTradesOperationExchangeEnum = {
     Kalshi: 'kalshi'
 } as const;
 export type FetchTradesOperationExchangeEnum = typeof FetchTradesOperationExchangeEnum[keyof typeof FetchTradesOperationExchangeEnum];
+/**
+ * @export
+ */
+export const GetExecutionPriceOperationExchangeEnum = {
+    Polymarket: 'polymarket',
+    Kalshi: 'kalshi'
+} as const;
+export type GetExecutionPriceOperationExchangeEnum = typeof GetExecutionPriceOperationExchangeEnum[keyof typeof GetExecutionPriceOperationExchangeEnum];
+/**
+ * @export
+ */
+export const GetExecutionPriceDetailedExchangeEnum = {
+    Polymarket: 'polymarket',
+    Kalshi: 'kalshi'
+} as const;
+export type GetExecutionPriceDetailedExchangeEnum = typeof GetExecutionPriceDetailedExchangeEnum[keyof typeof GetExecutionPriceDetailedExchangeEnum];
 /**
  * @export
  */

package/generated/src/models/ExecutionPriceResult.ts

@@ -0,0 +1,81 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ExecutionPriceResult
+ */
+export interface ExecutionPriceResult {
+    /**
+     * 
+     * @type {number}
+     * @memberof ExecutionPriceResult
+     */
+    price?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ExecutionPriceResult
+     */
+    filledAmount?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ExecutionPriceResult
+     */
+    fullyFilled?: boolean;
+}
+
+/**
+ * Check if a given object implements the ExecutionPriceResult interface.
+ */
+export function instanceOfExecutionPriceResult(value: object): value is ExecutionPriceResult {
+    return true;
+}
+
+export function ExecutionPriceResultFromJSON(json: any): ExecutionPriceResult {
+    return ExecutionPriceResultFromJSONTyped(json, false);
+}
+
+export function ExecutionPriceResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExecutionPriceResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'price': json['price'] == null ? undefined : json['price'],
+        'filledAmount': json['filledAmount'] == null ? undefined : json['filledAmount'],
+        'fullyFilled': json['fullyFilled'] == null ? undefined : json['fullyFilled'],
+    };
+}
+
+export function ExecutionPriceResultToJSON(json: any): ExecutionPriceResult {
+    return ExecutionPriceResultToJSONTyped(json, false);
+}
+
+export function ExecutionPriceResultToJSONTyped(value?: ExecutionPriceResult | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'price': value['price'],
+        'filledAmount': value['filledAmount'],
+        'fullyFilled': value['fullyFilled'],
+    };
+}
+

package/generated/src/models/GetExecutionPrice200Response.ts

@@ -0,0 +1,89 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { ErrorDetail } from './ErrorDetail';
+import {
+    ErrorDetailFromJSON,
+    ErrorDetailFromJSONTyped,
+    ErrorDetailToJSON,
+    ErrorDetailToJSONTyped,
+} from './ErrorDetail';
+
+/**
+ * 
+ * @export
+ * @interface GetExecutionPrice200Response
+ */
+export interface GetExecutionPrice200Response {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetExecutionPrice200Response
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {ErrorDetail}
+     * @memberof GetExecutionPrice200Response
+     */
+    error?: ErrorDetail;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetExecutionPrice200Response
+     */
+    data?: number;
+}
+
+/**
+ * Check if a given object implements the GetExecutionPrice200Response interface.
+ */
+export function instanceOfGetExecutionPrice200Response(value: object): value is GetExecutionPrice200Response {
+    return true;
+}
+
+export function GetExecutionPrice200ResponseFromJSON(json: any): GetExecutionPrice200Response {
+    return GetExecutionPrice200ResponseFromJSONTyped(json, false);
+}
+
+export function GetExecutionPrice200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetExecutionPrice200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'] == null ? undefined : json['success'],
+        'error': json['error'] == null ? undefined : ErrorDetailFromJSON(json['error']),
+        'data': json['data'] == null ? undefined : json['data'],
+    };
+}
+
+export function GetExecutionPrice200ResponseToJSON(json: any): GetExecutionPrice200Response {
+    return GetExecutionPrice200ResponseToJSONTyped(json, false);
+}
+
+export function GetExecutionPrice200ResponseToJSONTyped(value?: GetExecutionPrice200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': ErrorDetailToJSON(value['error']),
+        'data': value['data'],
+    };
+}
+