kalshi-typescript 3.10.0 → 3.12.0

package/dist/api/live-data-api.js

@@ -5,7 +5,7 @@
  * Kalshi Trade API Manual Endpoints
  * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 3.10.0
+ * The version of the OpenAPI document: 3.12.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,14 +38,44 @@ const base_1 = require("../base");
 const LiveDataApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Get live data for a specific milestone
-         * @summary Get Live Data
+         * Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men\'s Basketball, College Women\'s Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
+         * @summary Get Game Stats
+         * @param {string} milestoneId Milestone ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGameStats: (milestoneId_1, ...args_1) => __awaiter(this, [milestoneId_1, ...args_1], void 0, function* (milestoneId, options = {}) {
+            // verify required parameter 'milestoneId' is not null or undefined
+            (0, common_1.assertParamExists)('getGameStats', 'milestoneId', milestoneId);
+            const localVarPath = `/live_data/milestone/{milestone_id}/game_stats`
+                .replace(`{${"milestone_id"}}`, encodeURIComponent(String(milestoneId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
+         * @summary Get Live Data (with type)
          * @param {string} type Type of live data
          * @param {string} milestoneId Milestone ID
+         * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\'s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLiveData: (type_1, milestoneId_1, ...args_1) => __awaiter(this, [type_1, milestoneId_1, ...args_1], void 0, function* (type, milestoneId, options = {}) {
+        getLiveData: (type_1, milestoneId_1, includePlayerStats_1, ...args_1) => __awaiter(this, [type_1, milestoneId_1, includePlayerStats_1, ...args_1], void 0, function* (type, milestoneId, includePlayerStats, options = {}) {
             // verify required parameter 'type' is not null or undefined
             (0, common_1.assertParamExists)('getLiveData', 'type', type);
             // verify required parameter 'milestoneId' is not null or undefined
@@ -62,6 +92,42 @@ const LiveDataApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
+            if (includePlayerStats !== undefined) {
+                localVarQueryParameter['include_player_stats'] = includePlayerStats;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Get live data for a specific milestone.
+         * @summary Get Live Data
+         * @param {string} milestoneId Milestone ID
+         * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\'s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLiveDataByMilestone: (milestoneId_1, includePlayerStats_1, ...args_1) => __awaiter(this, [milestoneId_1, includePlayerStats_1, ...args_1], void 0, function* (milestoneId, includePlayerStats, options = {}) {
+            // verify required parameter 'milestoneId' is not null or undefined
+            (0, common_1.assertParamExists)('getLiveDataByMilestone', 'milestoneId', milestoneId);
+            const localVarPath = `/live_data/milestone/{milestone_id}`
+                .replace(`{${"milestone_id"}}`, encodeURIComponent(String(milestoneId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            if (includePlayerStats !== undefined) {
+                localVarQueryParameter['include_player_stats'] = includePlayerStats;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -74,10 +140,11 @@ const LiveDataApiAxiosParamCreator = function (configuration) {
          * Get live data for multiple milestones
          * @summary Get Multiple Live Data
          * @param {Array<string>} milestoneIds Array of milestone IDs
+         * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLiveDatas: (milestoneIds_1, ...args_1) => __awaiter(this, [milestoneIds_1, ...args_1], void 0, function* (milestoneIds, options = {}) {
+        getLiveDatas: (milestoneIds_1, includePlayerStats_1, ...args_1) => __awaiter(this, [milestoneIds_1, includePlayerStats_1, ...args_1], void 0, function* (milestoneIds, includePlayerStats, options = {}) {
             // verify required parameter 'milestoneIds' is not null or undefined
             (0, common_1.assertParamExists)('getLiveDatas', 'milestoneIds', milestoneIds);
             const localVarPath = `/live_data/batch`;
@@ -93,6 +160,9 @@ const LiveDataApiAxiosParamCreator = function (configuration) {
             if (milestoneIds) {
                 localVarQueryParameter['milestone_ids'] = milestoneIds;
             }
+            if (includePlayerStats !== undefined) {
+                localVarQueryParameter['include_player_stats'] = includePlayerStats;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -111,17 +181,51 @@ const LiveDataApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.LiveDataApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Get live data for a specific milestone
-         * @summary Get Live Data
+         * Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men\'s Basketball, College Women\'s Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
+         * @summary Get Game Stats
+         * @param {string} milestoneId Milestone ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGameStats(milestoneId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getGameStats(milestoneId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = undefined;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
+         * @summary Get Live Data (with type)
          * @param {string} type Type of live data
          * @param {string} milestoneId Milestone ID
+         * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLiveData(type, milestoneId, options) {
+        getLiveData(type, milestoneId, includePlayerStats, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLiveData(type, milestoneId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLiveData(type, milestoneId, includePlayerStats, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = undefined;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Get live data for a specific milestone.
+         * @summary Get Live Data
+         * @param {string} milestoneId Milestone ID
+         * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLiveDataByMilestone(milestoneId, includePlayerStats, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLiveDataByMilestone(milestoneId, includePlayerStats, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = undefined;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -131,13 +235,14 @@ const LiveDataApiFp = function (configuration) {
          * Get live data for multiple milestones
          * @summary Get Multiple Live Data
          * @param {Array<string>} milestoneIds Array of milestone IDs
+         * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLiveDatas(milestoneIds, options) {
+        getLiveDatas(milestoneIds, includePlayerStats, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLiveDatas(milestoneIds, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLiveDatas(milestoneIds, includePlayerStats, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = undefined;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -153,25 +258,48 @@ const LiveDataApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.LiveDataApiFp)(configuration);
     return {
         /**
-         * Get live data for a specific milestone
-         * @summary Get Live Data
+         * Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men\'s Basketball, College Women\'s Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
+         * @summary Get Game Stats
+         * @param {string} milestoneId Milestone ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGameStats(milestoneId, options) {
+            return localVarFp.getGameStats(milestoneId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
+         * @summary Get Live Data (with type)
          * @param {string} type Type of live data
          * @param {string} milestoneId Milestone ID
+         * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLiveData(type, milestoneId, options) {
-            return localVarFp.getLiveData(type, milestoneId, options).then((request) => request(axios, basePath));
+        getLiveData(type, milestoneId, includePlayerStats, options) {
+            return localVarFp.getLiveData(type, milestoneId, includePlayerStats, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get live data for a specific milestone.
+         * @summary Get Live Data
+         * @param {string} milestoneId Milestone ID
+         * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLiveDataByMilestone(milestoneId, includePlayerStats, options) {
+            return localVarFp.getLiveDataByMilestone(milestoneId, includePlayerStats, options).then((request) => request(axios, basePath));
         },
         /**
          * Get live data for multiple milestones
          * @summary Get Multiple Live Data
          * @param {Array<string>} milestoneIds Array of milestone IDs
+         * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLiveDatas(milestoneIds, options) {
-            return localVarFp.getLiveDatas(milestoneIds, options).then((request) => request(axios, basePath));
+        getLiveDatas(milestoneIds, includePlayerStats, options) {
+            return localVarFp.getLiveDatas(milestoneIds, includePlayerStats, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -181,25 +309,48 @@ exports.LiveDataApiFactory = LiveDataApiFactory;
  */
 class LiveDataApi extends base_1.BaseAPI {
     /**
-     * Get live data for a specific milestone
-     * @summary Get Live Data
+     * Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men\'s Basketball, College Women\'s Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
+     * @summary Get Game Stats
+     * @param {string} milestoneId Milestone ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGameStats(milestoneId, options) {
+        return (0, exports.LiveDataApiFp)(this.configuration).getGameStats(milestoneId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
+     * @summary Get Live Data (with type)
      * @param {string} type Type of live data
      * @param {string} milestoneId Milestone ID
+     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLiveData(type, milestoneId, includePlayerStats, options) {
+        return (0, exports.LiveDataApiFp)(this.configuration).getLiveData(type, milestoneId, includePlayerStats, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get live data for a specific milestone.
+     * @summary Get Live Data
+     * @param {string} milestoneId Milestone ID
+     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getLiveData(type, milestoneId, options) {
-        return (0, exports.LiveDataApiFp)(this.configuration).getLiveData(type, milestoneId, options).then((request) => request(this.axios, this.basePath));
+    getLiveDataByMilestone(milestoneId, includePlayerStats, options) {
+        return (0, exports.LiveDataApiFp)(this.configuration).getLiveDataByMilestone(milestoneId, includePlayerStats, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Get live data for multiple milestones
      * @summary Get Multiple Live Data
      * @param {Array<string>} milestoneIds Array of milestone IDs
+     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getLiveDatas(milestoneIds, options) {
-        return (0, exports.LiveDataApiFp)(this.configuration).getLiveDatas(milestoneIds, options).then((request) => request(this.axios, this.basePath));
+    getLiveDatas(milestoneIds, includePlayerStats, options) {
+        return (0, exports.LiveDataApiFp)(this.configuration).getLiveDatas(milestoneIds, includePlayerStats, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.LiveDataApi = LiveDataApi;

package/dist/api/market-api.d.ts

@@ -2,7 +2,7 @@
  * Kalshi Trade API Manual Endpoints
  * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 3.10.0
+ * The version of the OpenAPI document: 3.12.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../base';
 import type { BatchGetMarketCandlesticksResponse } from '../models';
 import type { GetMarketCandlesticksResponse } from '../models';
 import type { GetMarketOrderbookResponse } from '../models';
+import type { GetMarketOrderbooksResponse } from '../models';
 import type { GetMarketResponse } from '../models';
 import type { GetMarketsResponse } from '../models';
 import type { GetSeriesListResponse } from '../models';
@@ -66,6 +67,14 @@ export declare const MarketApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getMarketOrderbook: (ticker: string, depth?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
+     * @summary Get Multiple Market Orderbooks
+     * @param {Array<string>} tickers List of market tickers to fetch orderbooks for
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketOrderbooks: (tickers: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
      * @summary Get Markets
@@ -167,6 +176,14 @@ export declare const MarketApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketOrderbookResponse>>;
+    /**
+     * Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
+     * @summary Get Multiple Market Orderbooks
+     * @param {Array<string>} tickers List of market tickers to fetch orderbooks for
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketOrderbooks(tickers: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketOrderbooksResponse>>;
     /**
      * Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
      * @summary Get Markets
@@ -268,6 +285,14 @@ export declare const MarketApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketOrderbookResponse>;
+    /**
+     * Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
+     * @summary Get Multiple Market Orderbooks
+     * @param {Array<string>} tickers List of market tickers to fetch orderbooks for
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketOrderbooks(tickers: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketOrderbooksResponse>;
     /**
      * Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
      * @summary Get Markets
@@ -369,6 +394,14 @@ export declare class MarketApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketOrderbookResponse, any, {}>>;
+    /**
+     * Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
+     * @summary Get Multiple Market Orderbooks
+     * @param {Array<string>} tickers List of market tickers to fetch orderbooks for
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketOrderbooks(tickers: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketOrderbooksResponse, any, {}>>;
     /**
      * Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
      * @summary Get Markets

package/dist/api/market-api.js

@@ -5,7 +5,7 @@
  * Kalshi Trade API Manual Endpoints
  * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 3.10.0
+ * The version of the OpenAPI document: 3.12.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -213,6 +213,43 @@ const MarketApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
+         * @summary Get Multiple Market Orderbooks
+         * @param {Array<string>} tickers List of market tickers to fetch orderbooks for
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMarketOrderbooks: (tickers_1, ...args_1) => __awaiter(this, [tickers_1, ...args_1], void 0, function* (tickers, options = {}) {
+            // verify required parameter 'tickers' is not null or undefined
+            (0, common_1.assertParamExists)('getMarketOrderbooks', 'tickers', tickers);
+            const localVarPath = `/markets/orderbooks`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication kalshiAccessSignature required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
+            // authentication kalshiAccessKey required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
+            // authentication kalshiAccessTimestamp required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
+            if (tickers) {
+                localVarQueryParameter['tickers'] = tickers;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
          * @summary Get Markets
@@ -500,6 +537,22 @@ const MarketApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
+         * @summary Get Multiple Market Orderbooks
+         * @param {Array<string>} tickers List of market tickers to fetch orderbooks for
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMarketOrderbooks(tickers, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarketOrderbooks(tickers, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = undefined;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
          * @summary Get Markets
@@ -645,6 +698,16 @@ const MarketApiFactory = function (configuration, basePath, axios) {
         getMarketOrderbook(ticker, depth, options) {
             return localVarFp.getMarketOrderbook(ticker, depth, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
+         * @summary Get Multiple Market Orderbooks
+         * @param {Array<string>} tickers List of market tickers to fetch orderbooks for
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMarketOrderbooks(tickers, options) {
+            return localVarFp.getMarketOrderbooks(tickers, options).then((request) => request(axios, basePath));
+        },
         /**
          * Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
          * @summary Get Markets
@@ -764,6 +827,16 @@ class MarketApi extends base_1.BaseAPI {
     getMarketOrderbook(ticker, depth, options) {
         return (0, exports.MarketApiFp)(this.configuration).getMarketOrderbook(ticker, depth, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
+     * @summary Get Multiple Market Orderbooks
+     * @param {Array<string>} tickers List of market tickers to fetch orderbooks for
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketOrderbooks(tickers, options) {
+        return (0, exports.MarketApiFp)(this.configuration).getMarketOrderbooks(tickers, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
      * @summary Get Markets

package/dist/api/milestone-api.d.ts

@@ -2,7 +2,7 @@
  * Kalshi Trade API Manual Endpoints
  * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 3.10.0
+ * The version of the OpenAPI document: 3.12.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -31,10 +31,10 @@ export declare const MilestoneApiAxiosParamCreator: (configuration?: Configurati
      * @summary Get Milestones
      * @param {number} limit Number of milestones to return per page
      * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
-     * @param {string} [category] Filter by milestone category
-     * @param {string} [competition] Filter by competition
+     * @param {string} [category] Filter by milestone category. E.g. Sports, Elections, Esports, Crypto.
+     * @param {string} [competition] Filter by competition. E.g. Pro Football, Pro Basketball (M), Pro Baseball, Pro Hockey, College Football.
      * @param {string} [sourceId] Filter by source id
-     * @param {string} [type] Filter by milestone type
+     * @param {string} [type] Filter by milestone type. E.g. football_game, basketball_game, soccer_tournament_multi_leg, baseball_game, hockey_match, political_race.
      * @param {string} [relatedEventTicker] Filter by related event ticker
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
      * @param {number} [minUpdatedTs] Filter milestones with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
@@ -60,10 +60,10 @@ export declare const MilestoneApiFp: (configuration?: Configuration) => {
      * @summary Get Milestones
      * @param {number} limit Number of milestones to return per page
      * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
-     * @param {string} [category] Filter by milestone category
-     * @param {string} [competition] Filter by competition
+     * @param {string} [category] Filter by milestone category. E.g. Sports, Elections, Esports, Crypto.
+     * @param {string} [competition] Filter by competition. E.g. Pro Football, Pro Basketball (M), Pro Baseball, Pro Hockey, College Football.
      * @param {string} [sourceId] Filter by source id
-     * @param {string} [type] Filter by milestone type
+     * @param {string} [type] Filter by milestone type. E.g. football_game, basketball_game, soccer_tournament_multi_leg, baseball_game, hockey_match, political_race.
      * @param {string} [relatedEventTicker] Filter by related event ticker
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
      * @param {number} [minUpdatedTs] Filter milestones with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
@@ -89,10 +89,10 @@ export declare const MilestoneApiFactory: (configuration?: Configuration, basePa
      * @summary Get Milestones
      * @param {number} limit Number of milestones to return per page
      * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
-     * @param {string} [category] Filter by milestone category
-     * @param {string} [competition] Filter by competition
+     * @param {string} [category] Filter by milestone category. E.g. Sports, Elections, Esports, Crypto.
+     * @param {string} [competition] Filter by competition. E.g. Pro Football, Pro Basketball (M), Pro Baseball, Pro Hockey, College Football.
      * @param {string} [sourceId] Filter by source id
-     * @param {string} [type] Filter by milestone type
+     * @param {string} [type] Filter by milestone type. E.g. football_game, basketball_game, soccer_tournament_multi_leg, baseball_game, hockey_match, political_race.
      * @param {string} [relatedEventTicker] Filter by related event ticker
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
      * @param {number} [minUpdatedTs] Filter milestones with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
@@ -118,10 +118,10 @@ export declare class MilestoneApi extends BaseAPI {
      * @summary Get Milestones
      * @param {number} limit Number of milestones to return per page
      * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
-     * @param {string} [category] Filter by milestone category
-     * @param {string} [competition] Filter by competition
+     * @param {string} [category] Filter by milestone category. E.g. Sports, Elections, Esports, Crypto.
+     * @param {string} [competition] Filter by competition. E.g. Pro Football, Pro Basketball (M), Pro Baseball, Pro Hockey, College Football.
      * @param {string} [sourceId] Filter by source id
-     * @param {string} [type] Filter by milestone type
+     * @param {string} [type] Filter by milestone type. E.g. football_game, basketball_game, soccer_tournament_multi_leg, baseball_game, hockey_match, political_race.
      * @param {string} [relatedEventTicker] Filter by related event ticker
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
      * @param {number} [minUpdatedTs] Filter milestones with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.