pmxtjs 2.35.29 → 2.35.32

package/generated/docs/DefaultApi.md

@@ -43,6 +43,7 @@ All URIs are relative to *http://localhost:3847*
 | [**unwatchOrderBook**](DefaultApi.md#unwatchorderbookoperation) | **POST** /api/{exchange}/unwatchOrderBook | Unwatch Order Book |
 | [**watchAddress**](DefaultApi.md#watchaddressoperation) | **POST** /api/{exchange}/watchAddress | Watch Address |
 | [**watchOrderBook**](DefaultApi.md#watchorderbookoperation) | **POST** /api/{exchange}/watchOrderBook | Watch Order Book |
+| [**watchOrderBooks**](DefaultApi.md#watchorderbooksoperation) | **POST** /api/{exchange}/watchOrderBooks | Watch Order Books |
 | [**watchTrades**](DefaultApi.md#watchtradesoperation) | **POST** /api/{exchange}/watchTrades | Watch Trades |
 
 
@@ -3098,6 +3099,76 @@ 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)
 
 
+## watchOrderBooks
+
+> WatchOrderBooks200Response watchOrderBooks(exchange, watchOrderBooksRequest)
+
+Watch Order Books
+
+Watch multiple order books simultaneously via WebSocket. Returns a promise that resolves with a record of order book snapshots keyed by ID. Exchanges with native batch support (e.g. Kalshi) send a single subscribe message for all tickers; others fall back to individual watchOrderBook calls.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from 'pmxtjs';
+import type { WatchOrderBooksOperationRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | 'router' | The prediction market exchange to target.
+    exchange: exchange_example,
+    // WatchOrderBooksRequest (optional)
+    watchOrderBooksRequest: ...,
+  } satisfies WatchOrderBooksOperationRequest;
+
+  try {
+    const data = await api.watchOrderBooks(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us`, `router` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, router] |
+| **watchOrderBooksRequest** | [WatchOrderBooksRequest](WatchOrderBooksRequest.md) |  | [Optional] |
+
+### Return type
+
+[**WatchOrderBooks200Response**](WatchOrderBooks200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Watch Order Books response |  -  |
+
+[[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)

package/generated/docs/WatchOrderBooks200Response.md

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

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

@@ -0,0 +1,32 @@
+
+# WatchOrderBooksRequestArgsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { WatchOrderBooksRequestArgsInner } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies WatchOrderBooksRequestArgsInner
+
+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 WatchOrderBooksRequestArgsInner
+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": "2.35.29",
+  "version": "2.35.32",
   "description": "OpenAPI client for pmxtjs",
   "author": "OpenAPI-Generator",
   "repository": {

package/generated/src/apis/DefaultApi.ts

@@ -60,6 +60,8 @@ import type {
   WatchAddress200Response,
   WatchAddressRequest,
   WatchOrderBookRequest,
+  WatchOrderBooks200Response,
+  WatchOrderBooksRequest,
   WatchTradesRequest,
 } from '../models/index';
 import {
@@ -153,6 +155,10 @@ import {
     WatchAddressRequestToJSON,
     WatchOrderBookRequestFromJSON,
     WatchOrderBookRequestToJSON,
+    WatchOrderBooks200ResponseFromJSON,
+    WatchOrderBooks200ResponseToJSON,
+    WatchOrderBooksRequestFromJSON,
+    WatchOrderBooksRequestToJSON,
     WatchTradesRequestFromJSON,
     WatchTradesRequestToJSON,
 } from '../models/index';
@@ -463,6 +469,11 @@ export interface WatchOrderBookOperationRequest {
     watchOrderBookRequest?: WatchOrderBookRequest;
 }
 
+export interface WatchOrderBooksOperationRequest {
+    exchange: WatchOrderBooksOperationExchangeEnum;
+    watchOrderBooksRequest?: WatchOrderBooksRequest;
+}
+
 export interface WatchTradesOperationRequest {
     exchange: WatchTradesOperationExchangeEnum;
     watchTradesRequest?: WatchTradesRequest;
@@ -2607,6 +2618,48 @@ export class DefaultApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Watch multiple order books simultaneously via WebSocket. Returns a promise that resolves with a record of order book snapshots keyed by ID. Exchanges with native batch support (e.g. Kalshi) send a single subscribe message for all tickers; others fall back to individual watchOrderBook calls.
+     * Watch Order Books
+     */
+    async watchOrderBooksRaw(requestParameters: WatchOrderBooksOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WatchOrderBooks200Response>> {
+        if (requestParameters['exchange'] == null) {
+            throw new runtime.RequiredError(
+                'exchange',
+                'Required parameter "exchange" was null or undefined when calling watchOrderBooks().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/{exchange}/watchOrderBooks`;
+        urlPath = urlPath.replace(`{${"exchange"}}`, encodeURIComponent(String(requestParameters['exchange'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: WatchOrderBooksRequestToJSON(requestParameters['watchOrderBooksRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WatchOrderBooks200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Watch multiple order books simultaneously via WebSocket. Returns a promise that resolves with a record of order book snapshots keyed by ID. Exchanges with native batch support (e.g. Kalshi) send a single subscribe message for all tickers; others fall back to individual watchOrderBook calls.
+     * Watch Order Books
+     */
+    async watchOrderBooks(requestParameters: WatchOrderBooksOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WatchOrderBooks200Response> {
+        const response = await this.watchOrderBooksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Watch trade executions in real-time 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
@@ -3551,6 +3604,24 @@ export const WatchOrderBookOperationExchangeEnum = {
     Router: 'router'
 } as const;
 export type WatchOrderBookOperationExchangeEnum = typeof WatchOrderBookOperationExchangeEnum[keyof typeof WatchOrderBookOperationExchangeEnum];
+/**
+ * @export
+ */
+export const WatchOrderBooksOperationExchangeEnum = {
+    Polymarket: 'polymarket',
+    Kalshi: 'kalshi',
+    KalshiDemo: 'kalshi-demo',
+    Limitless: 'limitless',
+    Probable: 'probable',
+    Baozi: 'baozi',
+    Myriad: 'myriad',
+    Opinion: 'opinion',
+    Metaculus: 'metaculus',
+    Smarkets: 'smarkets',
+    PolymarketUs: 'polymarket_us',
+    Router: 'router'
+} as const;
+export type WatchOrderBooksOperationExchangeEnum = typeof WatchOrderBooksOperationExchangeEnum[keyof typeof WatchOrderBooksOperationExchangeEnum];
 /**
  * @export
  */

package/generated/src/models/WatchOrderBooks200Response.ts

@@ -0,0 +1,96 @@
+/* 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';
+import type { ErrorDetail } from './ErrorDetail';
+import {
+    ErrorDetailFromJSON,
+    ErrorDetailFromJSONTyped,
+    ErrorDetailToJSON,
+    ErrorDetailToJSONTyped,
+} from './ErrorDetail';
+import type { OrderBook } from './OrderBook';
+import {
+    OrderBookFromJSON,
+    OrderBookFromJSONTyped,
+    OrderBookToJSON,
+    OrderBookToJSONTyped,
+} from './OrderBook';
+
+/**
+ * 
+ * @export
+ * @interface WatchOrderBooks200Response
+ */
+export interface WatchOrderBooks200Response {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof WatchOrderBooks200Response
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {ErrorDetail}
+     * @memberof WatchOrderBooks200Response
+     */
+    error?: ErrorDetail;
+    /**
+     * 
+     * @type {{ [key: string]: OrderBook; }}
+     * @memberof WatchOrderBooks200Response
+     */
+    data?: { [key: string]: OrderBook; };
+}
+
+/**
+ * Check if a given object implements the WatchOrderBooks200Response interface.
+ */
+export function instanceOfWatchOrderBooks200Response(value: object): value is WatchOrderBooks200Response {
+    return true;
+}
+
+export function WatchOrderBooks200ResponseFromJSON(json: any): WatchOrderBooks200Response {
+    return WatchOrderBooks200ResponseFromJSONTyped(json, false);
+}
+
+export function WatchOrderBooks200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WatchOrderBooks200Response {
+    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 : (mapValues(json['data'], OrderBookFromJSON)),
+    };
+}
+
+export function WatchOrderBooks200ResponseToJSON(json: any): WatchOrderBooks200Response {
+    return WatchOrderBooks200ResponseToJSONTyped(json, false);
+}
+
+export function WatchOrderBooks200ResponseToJSONTyped(value?: WatchOrderBooks200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': ErrorDetailToJSON(value['error']),
+        'data': value['data'] == null ? undefined : (mapValues(value['data'], OrderBookToJSON)),
+    };
+}
+

package/generated/src/models/WatchOrderBooksRequest.ts

@@ -0,0 +1,89 @@
+/* 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';
+import type { ExchangeCredentials } from './ExchangeCredentials';
+import {
+    ExchangeCredentialsFromJSON,
+    ExchangeCredentialsFromJSONTyped,
+    ExchangeCredentialsToJSON,
+    ExchangeCredentialsToJSONTyped,
+} from './ExchangeCredentials';
+import type { WatchOrderBooksRequestArgsInner } from './WatchOrderBooksRequestArgsInner';
+import {
+    WatchOrderBooksRequestArgsInnerFromJSON,
+    WatchOrderBooksRequestArgsInnerFromJSONTyped,
+    WatchOrderBooksRequestArgsInnerToJSON,
+    WatchOrderBooksRequestArgsInnerToJSONTyped,
+} from './WatchOrderBooksRequestArgsInner';
+
+/**
+ * 
+ * @export
+ * @interface WatchOrderBooksRequest
+ */
+export interface WatchOrderBooksRequest {
+    /**
+     * 
+     * @type {Array<WatchOrderBooksRequestArgsInner>}
+     * @memberof WatchOrderBooksRequest
+     */
+    args: Array<WatchOrderBooksRequestArgsInner>;
+    /**
+     * 
+     * @type {ExchangeCredentials}
+     * @memberof WatchOrderBooksRequest
+     */
+    credentials?: ExchangeCredentials;
+}
+
+/**
+ * Check if a given object implements the WatchOrderBooksRequest interface.
+ */
+export function instanceOfWatchOrderBooksRequest(value: object): value is WatchOrderBooksRequest {
+    if (!('args' in value) || value['args'] === undefined) return false;
+    return true;
+}
+
+export function WatchOrderBooksRequestFromJSON(json: any): WatchOrderBooksRequest {
+    return WatchOrderBooksRequestFromJSONTyped(json, false);
+}
+
+export function WatchOrderBooksRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): WatchOrderBooksRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'args': ((json['args'] as Array<any>).map(WatchOrderBooksRequestArgsInnerFromJSON)),
+        'credentials': json['credentials'] == null ? undefined : ExchangeCredentialsFromJSON(json['credentials']),
+    };
+}
+
+export function WatchOrderBooksRequestToJSON(json: any): WatchOrderBooksRequest {
+    return WatchOrderBooksRequestToJSONTyped(json, false);
+}
+
+export function WatchOrderBooksRequestToJSONTyped(value?: WatchOrderBooksRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'args': ((value['args'] as Array<any>).map(WatchOrderBooksRequestArgsInnerToJSON)),
+        'credentials': ExchangeCredentialsToJSON(value['credentials']),
+    };
+}
+

package/generated/src/models/WatchOrderBooksRequestArgsInner.ts

@@ -0,0 +1,59 @@
+/* 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.
+ */
+
+/**
+ * @type WatchOrderBooksRequestArgsInner
+ * 
+ * @export
+ */
+export type WatchOrderBooksRequestArgsInner = Array<string> | number;
+
+export function WatchOrderBooksRequestArgsInnerFromJSON(json: any): WatchOrderBooksRequestArgsInner {
+    return WatchOrderBooksRequestArgsInnerFromJSONTyped(json, false);
+}
+
+export function WatchOrderBooksRequestArgsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): WatchOrderBooksRequestArgsInner {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json === 'number') {
+        return json;
+    }
+    if (Array.isArray(json)) {
+        if (json.every(item => typeof item === 'string')) {
+            return json;
+        }
+    }
+    return {} as any;
+}
+
+export function WatchOrderBooksRequestArgsInnerToJSON(json: any): any {
+    return WatchOrderBooksRequestArgsInnerToJSONTyped(json, false);
+}
+
+export function WatchOrderBooksRequestArgsInnerToJSONTyped(value?: WatchOrderBooksRequestArgsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value === 'number') {
+        return value;
+    }
+    if (Array.isArray(value)) {
+        if (value.every(item => typeof item === 'string')) {
+            return value;
+        }
+    }
+    return {};
+}
+

package/generated/src/models/index.ts

@@ -93,4 +93,7 @@ export * from './WatchAddressRequest';
 export * from './WatchAddressRequestArgsInner';
 export * from './WatchOrderBookRequest';
 export * from './WatchOrderBookRequestArgsInner';
+export * from './WatchOrderBooks200Response';
+export * from './WatchOrderBooksRequest';
+export * from './WatchOrderBooksRequestArgsInner';
 export * from './WatchTradesRequest';

package/package.json

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