pmxtjs 1.0.4 → 1.1.0

package/generated/docs/DefaultApi.md

@@ -17,6 +17,8 @@ All URIs are relative to *http://localhost:3847*
 | [**getMarketsBySlug**](DefaultApi.md#getmarketsbyslugoperation) | **POST** /api/{exchange}/getMarketsBySlug | Get Market by Slug |
 | [**healthCheck**](DefaultApi.md#healthcheck) | **GET** /health | Server Health Check |
 | [**searchMarkets**](DefaultApi.md#searchmarketsoperation) | **POST** /api/{exchange}/searchMarkets | Search Markets |
+| [**watchOrderBook**](DefaultApi.md#watchorderbookoperation) | **POST** /api/{exchange}/watchOrderBook | Watch Order Book (WebSocket Stream) |
+| [**watchTrades**](DefaultApi.md#watchtradesoperation) | **POST** /api/{exchange}/watchTrades | Watch Trades (WebSocket Stream) |
 
 
 
@@ -894,3 +896,143 @@ 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)
 
+
+## watchOrderBook
+
+> FetchOrderBook200Response watchOrderBook(exchange, watchOrderBookRequest)
+
+Watch Order Book (WebSocket Stream)
+
+Subscribe to real-time order book updates via WebSocket. Returns a promise that resolves with the next order book update. Call repeatedly in a loop to stream updates (CCXT Pro pattern). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from 'pmxtjs';
+import type { WatchOrderBookOperationRequest } 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,
+    // WatchOrderBookRequest (optional)
+    watchOrderBookRequest: ...,
+  } satisfies WatchOrderBookOperationRequest;
+
+  try {
+    const data = await api.watchOrderBook(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] |
+| **watchOrderBookRequest** | [WatchOrderBookRequest](WatchOrderBookRequest.md) |  | [Optional] |
+
+### Return type
+
+[**FetchOrderBook200Response**](FetchOrderBook200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Next order book update |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## watchTrades
+
+> FetchTrades200Response watchTrades(exchange, watchTradesRequest)
+
+Watch Trades (WebSocket Stream)
+
+Subscribe to real-time trade updates via WebSocket. Returns a promise that resolves with the next trade(s). Call repeatedly in a loop to stream updates (CCXT Pro pattern). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from 'pmxtjs';
+import type { WatchTradesOperationRequest } 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,
+    // WatchTradesRequest (optional)
+    watchTradesRequest: ...,
+  } satisfies WatchTradesOperationRequest;
+
+  try {
+    const data = await api.watchTrades(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] |
+| **watchTradesRequest** | [WatchTradesRequest](WatchTradesRequest.md) |  | [Optional] |
+
+### Return type
+
+[**FetchTrades200Response**](FetchTrades200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Next trade update(s) |  -  |
+
+[[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/WatchOrderBookRequest.md

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

@@ -0,0 +1,32 @@
+
+# WatchOrderBookRequestArgsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { WatchOrderBookRequestArgsInner } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies WatchOrderBookRequestArgsInner
+
+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 WatchOrderBookRequestArgsInner
+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/WatchTradesRequest.md

@@ -0,0 +1,36 @@
+
+# WatchTradesRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`args` | [Array<WatchOrderBookRequestArgsInner>](WatchOrderBookRequestArgsInner.md)
+`credentials` | [ExchangeCredentials](ExchangeCredentials.md)
+
+## Example
+
+```typescript
+import type { WatchTradesRequest } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "args": null,
+  "credentials": null,
+} satisfies WatchTradesRequest
+
+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 WatchTradesRequest
+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.0.4",
+  "version": "1.1.0",
   "description": "OpenAPI client for pmxtjs",
   "author": "OpenAPI-Generator",
   "repository": {

package/generated/src/apis/DefaultApi.ts

@@ -34,6 +34,8 @@ import type {
   GetMarketsBySlugRequest,
   HealthCheck200Response,
   SearchMarketsRequest,
+  WatchOrderBookRequest,
+  WatchTradesRequest,
 } from '../models/index';
 import {
     CancelOrderRequestFromJSON,
@@ -74,6 +76,10 @@ import {
     HealthCheck200ResponseToJSON,
     SearchMarketsRequestFromJSON,
     SearchMarketsRequestToJSON,
+    WatchOrderBookRequestFromJSON,
+    WatchOrderBookRequestToJSON,
+    WatchTradesRequestFromJSON,
+    WatchTradesRequestToJSON,
 } from '../models/index';
 
 export interface CancelOrderOperationRequest {
@@ -136,6 +142,16 @@ export interface SearchMarketsOperationRequest {
     searchMarketsRequest?: SearchMarketsRequest;
 }
 
+export interface WatchOrderBookOperationRequest {
+    exchange: WatchOrderBookOperationExchangeEnum;
+    watchOrderBookRequest?: WatchOrderBookRequest;
+}
+
+export interface WatchTradesOperationRequest {
+    exchange: WatchTradesOperationExchangeEnum;
+    watchTradesRequest?: WatchTradesRequest;
+}
+
 /**
  * 
  */
@@ -652,6 +668,90 @@ export class DefaultApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Subscribe to real-time order book updates via WebSocket. Returns a promise that resolves with the next order book update. Call repeatedly in a loop to stream updates (CCXT Pro pattern). 
+     * Watch Order Book (WebSocket Stream)
+     */
+    async watchOrderBookRaw(requestParameters: WatchOrderBookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchOrderBook200Response>> {
+        if (requestParameters['exchange'] == null) {
+            throw new runtime.RequiredError(
+                'exchange',
+                'Required parameter "exchange" was null or undefined when calling watchOrderBook().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/{exchange}/watchOrderBook`;
+        urlPath = urlPath.replace(`{${"exchange"}}`, encodeURIComponent(String(requestParameters['exchange'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: WatchOrderBookRequestToJSON(requestParameters['watchOrderBookRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FetchOrderBook200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Subscribe to real-time order book updates via WebSocket. Returns a promise that resolves with the next order book update. Call repeatedly in a loop to stream updates (CCXT Pro pattern). 
+     * Watch Order Book (WebSocket Stream)
+     */
+    async watchOrderBook(requestParameters: WatchOrderBookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchOrderBook200Response> {
+        const response = await this.watchOrderBookRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Subscribe to real-time trade updates via WebSocket. Returns a promise that resolves with the next trade(s). Call repeatedly in a loop to stream updates (CCXT Pro pattern). 
+     * Watch Trades (WebSocket Stream)
+     */
+    async watchTradesRaw(requestParameters: WatchTradesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchTrades200Response>> {
+        if (requestParameters['exchange'] == null) {
+            throw new runtime.RequiredError(
+                'exchange',
+                'Required parameter "exchange" was null or undefined when calling watchTrades().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/{exchange}/watchTrades`;
+        urlPath = urlPath.replace(`{${"exchange"}}`, encodeURIComponent(String(requestParameters['exchange'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: WatchTradesRequestToJSON(requestParameters['watchTradesRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FetchTrades200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Subscribe to real-time trade updates via WebSocket. Returns a promise that resolves with the next trade(s). Call repeatedly in a loop to stream updates (CCXT Pro pattern). 
+     * Watch Trades (WebSocket Stream)
+     */
+    async watchTrades(requestParameters: WatchTradesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchTrades200Response> {
+        const response = await this.watchTradesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }
 
 /**
@@ -750,3 +850,19 @@ export const SearchMarketsOperationExchangeEnum = {
     Kalshi: 'kalshi'
 } as const;
 export type SearchMarketsOperationExchangeEnum = typeof SearchMarketsOperationExchangeEnum[keyof typeof SearchMarketsOperationExchangeEnum];
+/**
+ * @export
+ */
+export const WatchOrderBookOperationExchangeEnum = {
+    Polymarket: 'polymarket',
+    Kalshi: 'kalshi'
+} as const;
+export type WatchOrderBookOperationExchangeEnum = typeof WatchOrderBookOperationExchangeEnum[keyof typeof WatchOrderBookOperationExchangeEnum];
+/**
+ * @export
+ */
+export const WatchTradesOperationExchangeEnum = {
+    Polymarket: 'polymarket',
+    Kalshi: 'kalshi'
+} as const;
+export type WatchTradesOperationExchangeEnum = typeof WatchTradesOperationExchangeEnum[keyof typeof WatchTradesOperationExchangeEnum];

package/generated/src/models/WatchOrderBookRequest.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 { ExchangeCredentials } from './ExchangeCredentials';
+import {
+    ExchangeCredentialsFromJSON,
+    ExchangeCredentialsFromJSONTyped,
+    ExchangeCredentialsToJSON,
+    ExchangeCredentialsToJSONTyped,
+} from './ExchangeCredentials';
+import type { WatchOrderBookRequestArgsInner } from './WatchOrderBookRequestArgsInner';
+import {
+    WatchOrderBookRequestArgsInnerFromJSON,
+    WatchOrderBookRequestArgsInnerFromJSONTyped,
+    WatchOrderBookRequestArgsInnerToJSON,
+    WatchOrderBookRequestArgsInnerToJSONTyped,
+} from './WatchOrderBookRequestArgsInner';
+
+/**
+ * 
+ * @export
+ * @interface WatchOrderBookRequest
+ */
+export interface WatchOrderBookRequest {
+    /**
+     * [outcomeId, limit?]
+     * @type {Array<WatchOrderBookRequestArgsInner>}
+     * @memberof WatchOrderBookRequest
+     */
+    args: Array<WatchOrderBookRequestArgsInner>;
+    /**
+     * 
+     * @type {ExchangeCredentials}
+     * @memberof WatchOrderBookRequest
+     */
+    credentials?: ExchangeCredentials;
+}
+
+/**
+ * Check if a given object implements the WatchOrderBookRequest interface.
+ */
+export function instanceOfWatchOrderBookRequest(value: object): value is WatchOrderBookRequest {
+    if (!('args' in value) || value['args'] === undefined) return false;
+    return true;
+}
+
+export function WatchOrderBookRequestFromJSON(json: any): WatchOrderBookRequest {
+    return WatchOrderBookRequestFromJSONTyped(json, false);
+}
+
+export function WatchOrderBookRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): WatchOrderBookRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'args': ((json['args'] as Array<any>).map(WatchOrderBookRequestArgsInnerFromJSON)),
+        'credentials': json['credentials'] == null ? undefined : ExchangeCredentialsFromJSON(json['credentials']),
+    };
+}
+
+export function WatchOrderBookRequestToJSON(json: any): WatchOrderBookRequest {
+    return WatchOrderBookRequestToJSONTyped(json, false);
+}
+
+export function WatchOrderBookRequestToJSONTyped(value?: WatchOrderBookRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'args': ((value['args'] as Array<any>).map(WatchOrderBookRequestArgsInnerToJSON)),
+        'credentials': ExchangeCredentialsToJSON(value['credentials']),
+    };
+}
+

package/generated/src/models/WatchOrderBookRequestArgsInner.ts

@@ -0,0 +1,55 @@
+/* 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.
+ */
+
+/**
+ * @type WatchOrderBookRequestArgsInner
+ * 
+ * @export
+ */
+export type WatchOrderBookRequestArgsInner = number | string;
+
+export function WatchOrderBookRequestArgsInnerFromJSON(json: any): WatchOrderBookRequestArgsInner {
+    return WatchOrderBookRequestArgsInnerFromJSONTyped(json, false);
+}
+
+export function WatchOrderBookRequestArgsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): WatchOrderBookRequestArgsInner {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json === 'number') {
+        return json;
+    }
+    if (typeof json === 'string') {
+        return json;
+    }
+    return {} as any;
+}
+
+export function WatchOrderBookRequestArgsInnerToJSON(json: any): any {
+    return WatchOrderBookRequestArgsInnerToJSONTyped(json, false);
+}
+
+export function WatchOrderBookRequestArgsInnerToJSONTyped(value?: WatchOrderBookRequestArgsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value === 'number') {
+        return value;
+    }
+    if (typeof value === 'string') {
+        return value;
+    }
+    return {};
+}
+

package/generated/src/models/WatchTradesRequest.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 { ExchangeCredentials } from './ExchangeCredentials';
+import {
+    ExchangeCredentialsFromJSON,
+    ExchangeCredentialsFromJSONTyped,
+    ExchangeCredentialsToJSON,
+    ExchangeCredentialsToJSONTyped,
+} from './ExchangeCredentials';
+import type { WatchOrderBookRequestArgsInner } from './WatchOrderBookRequestArgsInner';
+import {
+    WatchOrderBookRequestArgsInnerFromJSON,
+    WatchOrderBookRequestArgsInnerFromJSONTyped,
+    WatchOrderBookRequestArgsInnerToJSON,
+    WatchOrderBookRequestArgsInnerToJSONTyped,
+} from './WatchOrderBookRequestArgsInner';
+
+/**
+ * 
+ * @export
+ * @interface WatchTradesRequest
+ */
+export interface WatchTradesRequest {
+    /**
+     * [outcomeId, since?, limit?]
+     * @type {Array<WatchOrderBookRequestArgsInner>}
+     * @memberof WatchTradesRequest
+     */
+    args: Array<WatchOrderBookRequestArgsInner>;
+    /**
+     * 
+     * @type {ExchangeCredentials}
+     * @memberof WatchTradesRequest
+     */
+    credentials?: ExchangeCredentials;
+}
+
+/**
+ * Check if a given object implements the WatchTradesRequest interface.
+ */
+export function instanceOfWatchTradesRequest(value: object): value is WatchTradesRequest {
+    if (!('args' in value) || value['args'] === undefined) return false;
+    return true;
+}
+
+export function WatchTradesRequestFromJSON(json: any): WatchTradesRequest {
+    return WatchTradesRequestFromJSONTyped(json, false);
+}
+
+export function WatchTradesRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): WatchTradesRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'args': ((json['args'] as Array<any>).map(WatchOrderBookRequestArgsInnerFromJSON)),
+        'credentials': json['credentials'] == null ? undefined : ExchangeCredentialsFromJSON(json['credentials']),
+    };
+}
+
+export function WatchTradesRequestToJSON(json: any): WatchTradesRequest {
+    return WatchTradesRequestToJSONTyped(json, false);
+}
+
+export function WatchTradesRequestToJSONTyped(value?: WatchTradesRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'args': ((value['args'] as Array<any>).map(WatchOrderBookRequestArgsInnerToJSON)),
+        'credentials': ExchangeCredentialsToJSON(value['credentials']),
+    };
+}
+

package/generated/src/models/index.ts

@@ -38,3 +38,6 @@ export * from './SearchMarketsRequest';
 export * from './SearchMarketsRequestArgsInner';
 export * from './Trade';
 export * from './UnifiedMarket';
+export * from './WatchOrderBookRequest';
+export * from './WatchOrderBookRequestArgsInner';
+export * from './WatchTradesRequest';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "Unified prediction market data API - The ccxt for prediction markets",
   "author": "PMXT Contributors",
   "repository": {
@@ -42,7 +42,7 @@
     "unified"
   ],
   "dependencies": {
-    "pmxt-core": "1.0.4"
+    "pmxt-core": "1.1.0"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",