kalshi-typescript 3.6.0 → 3.8.0

package/dist/api/events-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.6.0
+ * The version of the OpenAPI document: 3.8.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,10 +38,10 @@ const base_1 = require("../base");
 const EventsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         *  Endpoint for getting data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
+         * Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
          * @summary Get Event
          * @param {string} eventTicker Event ticker
-         * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
+         * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. Historical markets settled before the historical cutoff will not be included.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -163,19 +163,20 @@ const EventsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint.
+         * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
          * @summary Get Events
          * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
          * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-         * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \'markets\' field containing a list of Market objects associated with that event.
+         * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \'markets\' field containing a list of Market objects associated with that event. Historical markets settled before the historical cutoff will not be included.
          * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
          * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \'open\', \'closed\', \'settled\'. Leave empty to return events with any status.
          * @param {string} [seriesTicker] Filter by series ticker
          * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
+         * @param {number} [minUpdatedTs] Filter events with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getEvents: (limit_1, cursor_1, withNestedMarkets_1, withMilestones_1, status_1, seriesTicker_1, minCloseTs_1, ...args_1) => __awaiter(this, [limit_1, cursor_1, withNestedMarkets_1, withMilestones_1, status_1, seriesTicker_1, minCloseTs_1, ...args_1], void 0, function* (limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options = {}) {
+        getEvents: (limit_1, cursor_1, withNestedMarkets_1, withMilestones_1, status_1, seriesTicker_1, minCloseTs_1, minUpdatedTs_1, ...args_1) => __awaiter(this, [limit_1, cursor_1, withNestedMarkets_1, withMilestones_1, status_1, seriesTicker_1, minCloseTs_1, minUpdatedTs_1, ...args_1], void 0, function* (limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, minUpdatedTs, options = {}) {
             const localVarPath = `/events`;
             // 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);
@@ -207,6 +208,9 @@ const EventsApiAxiosParamCreator = function (configuration) {
             if (minCloseTs !== undefined) {
                 localVarQueryParameter['min_close_ts'] = minCloseTs;
             }
+            if (minUpdatedTs !== undefined) {
+                localVarQueryParameter['min_updated_ts'] = minUpdatedTs;
+            }
             (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);
@@ -321,10 +325,10 @@ const EventsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.EventsApiAxiosParamCreator)(configuration);
     return {
         /**
-         *  Endpoint for getting data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
+         * Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
          * @summary Get Event
          * @param {string} eventTicker Event ticker
-         * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
+         * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. Historical markets settled before the historical cutoff will not be included.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -375,22 +379,23 @@ const EventsApiFp = function (configuration) {
             });
         },
         /**
-         * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint.
+         * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
          * @summary Get Events
          * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
          * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-         * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \'markets\' field containing a list of Market objects associated with that event.
+         * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \'markets\' field containing a list of Market objects associated with that event. Historical markets settled before the historical cutoff will not be included.
          * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
          * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \'open\', \'closed\', \'settled\'. Leave empty to return events with any status.
          * @param {string} [seriesTicker] Filter by series ticker
          * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
+         * @param {number} [minUpdatedTs] Filter events with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options) {
+        getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, minUpdatedTs, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, minUpdatedTs, 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);
@@ -446,10 +451,10 @@ const EventsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.EventsApiFp)(configuration);
     return {
         /**
-         *  Endpoint for getting data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
+         * Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
          * @summary Get Event
          * @param {string} eventTicker Event ticker
-         * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
+         * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. Historical markets settled before the historical cutoff will not be included.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -482,20 +487,21 @@ const EventsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getEventMetadata(eventTicker, options).then((request) => request(axios, basePath));
         },
         /**
-         * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint.
+         * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
          * @summary Get Events
          * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
          * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-         * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \'markets\' field containing a list of Market objects associated with that event.
+         * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \'markets\' field containing a list of Market objects associated with that event. Historical markets settled before the historical cutoff will not be included.
          * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
          * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \'open\', \'closed\', \'settled\'. Leave empty to return events with any status.
          * @param {string} [seriesTicker] Filter by series ticker
          * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
+         * @param {number} [minUpdatedTs] Filter events with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options) {
-            return localVarFp.getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options).then((request) => request(axios, basePath));
+        getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, minUpdatedTs, options) {
+            return localVarFp.getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, minUpdatedTs, options).then((request) => request(axios, basePath));
         },
         /**
          *  End-point for returning aggregated data across all markets corresponding to an event.
@@ -533,10 +539,10 @@ exports.EventsApiFactory = EventsApiFactory;
  */
 class EventsApi extends base_1.BaseAPI {
     /**
-     *  Endpoint for getting data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
+     * Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
      * @summary Get Event
      * @param {string} eventTicker Event ticker
-     * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
+     * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. Historical markets settled before the historical cutoff will not be included.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -569,20 +575,21 @@ class EventsApi extends base_1.BaseAPI {
         return (0, exports.EventsApiFp)(this.configuration).getEventMetadata(eventTicker, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint.
+     * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
      * @summary Get Events
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
      * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \'markets\' field containing a list of Market objects associated with that event.
+     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \'markets\' field containing a list of Market objects associated with that event. Historical markets settled before the historical cutoff will not be included.
      * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
      * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \'open\', \'closed\', \'settled\'. Leave empty to return events with any status.
      * @param {string} [seriesTicker] Filter by series ticker
      * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
+     * @param {number} [minUpdatedTs] Filter events with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options) {
-        return (0, exports.EventsApiFp)(this.configuration).getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options).then((request) => request(this.axios, this.basePath));
+    getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, minUpdatedTs, options) {
+        return (0, exports.EventsApiFp)(this.configuration).getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, minUpdatedTs, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *  End-point for returning aggregated data across all markets corresponding to an event.

package/dist/api/exchange-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.6.0
+ * The version of the OpenAPI document: 3.8.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/exchange-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.6.0
+ * The version of the OpenAPI document: 3.8.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/fcm-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.6.0
+ * The version of the OpenAPI document: 3.8.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/fcm-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.6.0
+ * The version of the OpenAPI document: 3.8.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -0,0 +1,290 @@
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.8.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { GetFillsResponse } from '../models';
+import type { GetHistoricalCutoffResponse } from '../models';
+import type { GetMarketCandlesticksHistoricalResponse } from '../models';
+import type { GetMarketResponse } from '../models';
+import type { GetMarketsResponse } from '../models';
+import type { GetOrdersResponse } from '../models';
+/**
+ * HistoricalApi - axios parameter creator
+ */
+export declare const HistoricalApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched.
+     * @summary Get Historical Fills
+     * @param {string} [ticker] Filter by market ticker
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFillsHistorical: (ticker?: string, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns the cutoff timestamps that define the boundary between **live** and **historical** data.  ## Cutoff fields - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`. - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`. - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`.
+     * @summary Get Historical Cutoff Timestamps
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalCutoff: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for getting data about a specific market by its ticker from the historical database.
+     * @summary Get Historical Market
+     * @param {string} ticker Market ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalMarket: (ticker: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive.
+     * @summary Get Historical Markets
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {string} [tickers] Filter by specific market tickers. Comma-separated list of market tickers to retrieve.
+     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+     * @param {GetHistoricalMarketsMveFilterEnum} [mveFilter] Filter by multivariate events (combos). By default, MVE markets are included.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalMarkets: (limit?: number, cursor?: string, tickers?: string, eventTicker?: string, mveFilter?: GetHistoricalMarketsMveFilterEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for getting orders that have been archived to the historical database.
+     * @summary Get Historical Orders
+     * @param {string} [ticker] Filter by market ticker
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalOrders: (ticker?: string, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
+     * @summary Get Historical Market Candlesticks
+     * @param {string} ticker Market ticker - unique identifier for the specific market
+     * @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
+     * @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
+     * @param {GetMarketCandlesticksHistoricalPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketCandlesticksHistorical: (ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksHistoricalPeriodIntervalEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * HistoricalApi - functional programming interface
+ */
+export declare const HistoricalApiFp: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched.
+     * @summary Get Historical Fills
+     * @param {string} [ticker] Filter by market ticker
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFillsHistorical(ticker?: string, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFillsResponse>>;
+    /**
+     * Returns the cutoff timestamps that define the boundary between **live** and **historical** data.  ## Cutoff fields - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`. - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`. - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`.
+     * @summary Get Historical Cutoff Timestamps
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalCutoff(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetHistoricalCutoffResponse>>;
+    /**
+     *  Endpoint for getting data about a specific market by its ticker from the historical database.
+     * @summary Get Historical Market
+     * @param {string} ticker Market ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalMarket(ticker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketResponse>>;
+    /**
+     * Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive.
+     * @summary Get Historical Markets
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {string} [tickers] Filter by specific market tickers. Comma-separated list of market tickers to retrieve.
+     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+     * @param {GetHistoricalMarketsMveFilterEnum} [mveFilter] Filter by multivariate events (combos). By default, MVE markets are included.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalMarkets(limit?: number, cursor?: string, tickers?: string, eventTicker?: string, mveFilter?: GetHistoricalMarketsMveFilterEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketsResponse>>;
+    /**
+     *  Endpoint for getting orders that have been archived to the historical database.
+     * @summary Get Historical Orders
+     * @param {string} [ticker] Filter by market ticker
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalOrders(ticker?: string, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
+    /**
+     *  Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
+     * @summary Get Historical Market Candlesticks
+     * @param {string} ticker Market ticker - unique identifier for the specific market
+     * @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
+     * @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
+     * @param {GetMarketCandlesticksHistoricalPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketCandlesticksHistorical(ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksHistoricalPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketCandlesticksHistoricalResponse>>;
+};
+/**
+ * HistoricalApi - factory interface
+ */
+export declare const HistoricalApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *  Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched.
+     * @summary Get Historical Fills
+     * @param {string} [ticker] Filter by market ticker
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFillsHistorical(ticker?: string, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFillsResponse>;
+    /**
+     * Returns the cutoff timestamps that define the boundary between **live** and **historical** data.  ## Cutoff fields - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`. - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`. - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`.
+     * @summary Get Historical Cutoff Timestamps
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalCutoff(options?: RawAxiosRequestConfig): AxiosPromise<GetHistoricalCutoffResponse>;
+    /**
+     *  Endpoint for getting data about a specific market by its ticker from the historical database.
+     * @summary Get Historical Market
+     * @param {string} ticker Market ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalMarket(ticker: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketResponse>;
+    /**
+     * Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive.
+     * @summary Get Historical Markets
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {string} [tickers] Filter by specific market tickers. Comma-separated list of market tickers to retrieve.
+     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+     * @param {GetHistoricalMarketsMveFilterEnum} [mveFilter] Filter by multivariate events (combos). By default, MVE markets are included.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalMarkets(limit?: number, cursor?: string, tickers?: string, eventTicker?: string, mveFilter?: GetHistoricalMarketsMveFilterEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketsResponse>;
+    /**
+     *  Endpoint for getting orders that have been archived to the historical database.
+     * @summary Get Historical Orders
+     * @param {string} [ticker] Filter by market ticker
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalOrders(ticker?: string, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
+    /**
+     *  Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
+     * @summary Get Historical Market Candlesticks
+     * @param {string} ticker Market ticker - unique identifier for the specific market
+     * @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
+     * @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
+     * @param {GetMarketCandlesticksHistoricalPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketCandlesticksHistorical(ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksHistoricalPeriodIntervalEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketCandlesticksHistoricalResponse>;
+};
+/**
+ * HistoricalApi - object-oriented interface
+ */
+export declare class HistoricalApi extends BaseAPI {
+    /**
+     *  Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched.
+     * @summary Get Historical Fills
+     * @param {string} [ticker] Filter by market ticker
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFillsHistorical(ticker?: string, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any, {}>>;
+    /**
+     * Returns the cutoff timestamps that define the boundary between **live** and **historical** data.  ## Cutoff fields - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`. - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`. - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`.
+     * @summary Get Historical Cutoff Timestamps
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalCutoff(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetHistoricalCutoffResponse, any, {}>>;
+    /**
+     *  Endpoint for getting data about a specific market by its ticker from the historical database.
+     * @summary Get Historical Market
+     * @param {string} ticker Market ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalMarket(ticker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketResponse, any, {}>>;
+    /**
+     * Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive.
+     * @summary Get Historical Markets
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {string} [tickers] Filter by specific market tickers. Comma-separated list of market tickers to retrieve.
+     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+     * @param {GetHistoricalMarketsMveFilterEnum} [mveFilter] Filter by multivariate events (combos). By default, MVE markets are included.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalMarkets(limit?: number, cursor?: string, tickers?: string, eventTicker?: string, mveFilter?: GetHistoricalMarketsMveFilterEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketsResponse, any, {}>>;
+    /**
+     *  Endpoint for getting orders that have been archived to the historical database.
+     * @summary Get Historical Orders
+     * @param {string} [ticker] Filter by market ticker
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHistoricalOrders(ticker?: string, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any, {}>>;
+    /**
+     *  Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
+     * @summary Get Historical Market Candlesticks
+     * @param {string} ticker Market ticker - unique identifier for the specific market
+     * @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
+     * @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
+     * @param {GetMarketCandlesticksHistoricalPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketCandlesticksHistorical(ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksHistoricalPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketCandlesticksHistoricalResponse, any, {}>>;
+}
+export declare const GetHistoricalMarketsMveFilterEnum: {
+    readonly Exclude: "exclude";
+};
+export type GetHistoricalMarketsMveFilterEnum = typeof GetHistoricalMarketsMveFilterEnum[keyof typeof GetHistoricalMarketsMveFilterEnum];
+export declare const GetMarketCandlesticksHistoricalPeriodIntervalEnum: {
+    readonly NUMBER_1: 1;
+    readonly NUMBER_60: 60;
+    readonly NUMBER_1440: 1440;
+};
+export type GetMarketCandlesticksHistoricalPeriodIntervalEnum = typeof GetMarketCandlesticksHistoricalPeriodIntervalEnum[keyof typeof GetMarketCandlesticksHistoricalPeriodIntervalEnum];