kalshi-typescript 3.3.0 → 3.5.0

package/README.md

@@ -1,4 +1,4 @@
-## kalshi-typescript@3.3.0
+## kalshi-typescript@3.5.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install kalshi-typescript@3.3.0 --save
+npm install kalshi-typescript@3.5.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -112,11 +112,15 @@ Class | Method | HTTP request | Description
 *OrdersApi* | [**getOrderQueuePosition**](docs/OrdersApi.md#getorderqueueposition) | **GET** /portfolio/orders/{order_id}/queue_position | Get Order Queue Position
 *OrdersApi* | [**getOrderQueuePositions**](docs/OrdersApi.md#getorderqueuepositions) | **GET** /portfolio/orders/queue_positions | Get Queue Positions for Orders
 *OrdersApi* | [**getOrders**](docs/OrdersApi.md#getorders) | **GET** /portfolio/orders | Get Orders
+*PortfolioApi* | [**applySubaccountTransfer**](docs/PortfolioApi.md#applysubaccounttransfer) | **POST** /portfolio/subaccounts/transfer | Transfer Between Subaccounts
+*PortfolioApi* | [**createSubaccount**](docs/PortfolioApi.md#createsubaccount) | **POST** /portfolio/subaccounts | Create Subaccount
 *PortfolioApi* | [**getBalance**](docs/PortfolioApi.md#getbalance) | **GET** /portfolio/balance | Get Balance
 *PortfolioApi* | [**getFills**](docs/PortfolioApi.md#getfills) | **GET** /portfolio/fills | Get Fills
 *PortfolioApi* | [**getPortfolioRestingOrderTotalValue**](docs/PortfolioApi.md#getportfoliorestingordertotalvalue) | **GET** /portfolio/summary/total_resting_order_value | Get Total Resting Order Value
 *PortfolioApi* | [**getPositions**](docs/PortfolioApi.md#getpositions) | **GET** /portfolio/positions | Get Positions
 *PortfolioApi* | [**getSettlements**](docs/PortfolioApi.md#getsettlements) | **GET** /portfolio/settlements | Get Settlements
+*PortfolioApi* | [**getSubaccountBalances**](docs/PortfolioApi.md#getsubaccountbalances) | **GET** /portfolio/subaccounts/balances | Get All Subaccount Balances
+*PortfolioApi* | [**getSubaccountTransfers**](docs/PortfolioApi.md#getsubaccounttransfers) | **GET** /portfolio/subaccounts/transfers | Get Subaccount Transfers
 *SearchApi* | [**getFiltersForSports**](docs/SearchApi.md#getfiltersforsports) | **GET** /search/filters_by_sport | Get Filters for Sports
 *SearchApi* | [**getTagsForSeriesCategories**](docs/SearchApi.md#gettagsforseriescategories) | **GET** /search/tags_by_categories | Get Tags for Series Categories
 *StructuredTargetsApi* | [**getStructuredTarget**](docs/StructuredTargetsApi.md#getstructuredtarget) | **GET** /structured_targets/{structured_target_id} | Get Structured Target
@@ -130,6 +134,7 @@ Class | Method | HTTP request | Description
  - [AmendOrderResponse](docs/AmendOrderResponse.md)
  - [Announcement](docs/Announcement.md)
  - [ApiKey](docs/ApiKey.md)
+ - [ApplySubaccountTransferRequest](docs/ApplySubaccountTransferRequest.md)
  - [AssociatedEvent](docs/AssociatedEvent.md)
  - [BatchCancelOrdersIndividualResponse](docs/BatchCancelOrdersIndividualResponse.md)
  - [BatchCancelOrdersRequest](docs/BatchCancelOrdersRequest.md)
@@ -152,12 +157,14 @@ Class | Method | HTTP request | Description
  - [CreateQuoteResponse](docs/CreateQuoteResponse.md)
  - [CreateRFQRequest](docs/CreateRFQRequest.md)
  - [CreateRFQResponse](docs/CreateRFQResponse.md)
+ - [CreateSubaccountResponse](docs/CreateSubaccountResponse.md)
  - [DailySchedule](docs/DailySchedule.md)
  - [DecreaseOrderRequest](docs/DecreaseOrderRequest.md)
  - [DecreaseOrderResponse](docs/DecreaseOrderResponse.md)
  - [ErrorResponse](docs/ErrorResponse.md)
  - [EventData](docs/EventData.md)
  - [EventPosition](docs/EventPosition.md)
+ - [ExchangeInstance](docs/ExchangeInstance.md)
  - [ExchangeStatus](docs/ExchangeStatus.md)
  - [Fill](docs/Fill.md)
  - [ForecastPercentilesPoint](docs/ForecastPercentilesPoint.md)
@@ -206,10 +213,14 @@ Class | Method | HTTP request | Description
  - [GetSettlementsResponse](docs/GetSettlementsResponse.md)
  - [GetStructuredTargetResponse](docs/GetStructuredTargetResponse.md)
  - [GetStructuredTargetsResponse](docs/GetStructuredTargetsResponse.md)
+ - [GetSubaccountBalancesResponse](docs/GetSubaccountBalancesResponse.md)
+ - [GetSubaccountTransfersResponse](docs/GetSubaccountTransfersResponse.md)
  - [GetTagsForSeriesCategoriesResponse](docs/GetTagsForSeriesCategoriesResponse.md)
  - [GetTradesResponse](docs/GetTradesResponse.md)
  - [GetUserDataTimestampResponse](docs/GetUserDataTimestampResponse.md)
  - [IncentiveProgram](docs/IncentiveProgram.md)
+ - [IntraExchangeInstanceTransferRequest](docs/IntraExchangeInstanceTransferRequest.md)
+ - [IntraExchangeInstanceTransferResponse](docs/IntraExchangeInstanceTransferResponse.md)
  - [LiveData](docs/LiveData.md)
  - [LookupPoint](docs/LookupPoint.md)
  - [LookupTickersForMarketInMultivariateEventCollectionRequest](docs/LookupTickersForMarketInMultivariateEventCollectionRequest.md)
@@ -228,6 +239,7 @@ Class | Method | HTTP request | Description
  - [OrderQueuePosition](docs/OrderQueuePosition.md)
  - [OrderStatus](docs/OrderStatus.md)
  - [Orderbook](docs/Orderbook.md)
+ - [OrderbookCountFp](docs/OrderbookCountFp.md)
  - [PercentilePoint](docs/PercentilePoint.md)
  - [PriceDistribution](docs/PriceDistribution.md)
  - [PriceRange](docs/PriceRange.md)
@@ -242,6 +254,8 @@ Class | Method | HTTP request | Description
  - [SettlementSource](docs/SettlementSource.md)
  - [SportFilterDetails](docs/SportFilterDetails.md)
  - [StructuredTarget](docs/StructuredTarget.md)
+ - [SubaccountBalance](docs/SubaccountBalance.md)
+ - [SubaccountTransfer](docs/SubaccountTransfer.md)
  - [TickerPair](docs/TickerPair.md)
  - [Trade](docs/Trade.md)
  - [WeeklySchedule](docs/WeeklySchedule.md)

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

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

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

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

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

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

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.3.0
+ * The version of the OpenAPI document: 3.5.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.3.0
+ * The version of the OpenAPI document: 3.5.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.3.0
+ * The version of the OpenAPI document: 3.5.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.3.0
+ * The version of the OpenAPI document: 3.5.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

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

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

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

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.3.0
+ * The version of the OpenAPI document: 3.5.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -52,10 +52,11 @@ export declare const MarketApiAxiosParamCreator: (configuration?: Configuration)
      * @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 {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
+     * @param {boolean} [includeLatestBeforeStart] If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by: 1. Finding the most recent real candlestick before start_ts 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts) 3. Setting all OHLC prices to null, and `previous_price` to the close price from the real candlestick
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getMarketCandlesticks: (seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getMarketCandlesticks: (seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, includeLatestBeforeStart?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *  Endpoint for getting the current order book for a specific market.  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.
      * @summary Get Market Orderbook
@@ -89,20 +90,22 @@ export declare const MarketApiAxiosParamCreator: (configuration?: Configuration)
      *  Endpoint for getting data about a specific series by its ticker.  A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
      * @summary Get Series
      * @param {string} seriesTicker The ticker of the series to retrieve
+     * @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSeries: (seriesTicker: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getSeries: (seriesTicker: string, includeVolume?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *  Endpoint for getting data about multiple series with specified filters.  A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). This endpoint allows you to browse and discover available series templates by category.
      * @summary Get Series List
      * @param {string} [category]
      * @param {string} [tags]
      * @param {boolean} [includeProductMetadata]
+     * @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSeriesList: (category?: string, tags?: string, includeProductMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getSeriesList: (category?: string, tags?: string, includeProductMetadata?: boolean, includeVolume?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *  Endpoint for getting all trades for all markets.  A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
      * @summary Get Trades
@@ -148,10 +151,11 @@ export declare const MarketApiFp: (configuration?: Configuration) => {
      * @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 {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
+     * @param {boolean} [includeLatestBeforeStart] If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by: 1. Finding the most recent real candlestick before start_ts 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts) 3. Setting all OHLC prices to null, and &#x60;previous_price&#x60; to the close price from the real candlestick
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketCandlesticksResponse>>;
+    getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, includeLatestBeforeStart?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketCandlesticksResponse>>;
     /**
      *  Endpoint for getting the current order book for a specific market.  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.
      * @summary Get Market Orderbook
@@ -185,20 +189,22 @@ export declare const MarketApiFp: (configuration?: Configuration) => {
      *  Endpoint for getting data about a specific series by its ticker.  A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
      * @summary Get Series
      * @param {string} seriesTicker The ticker of the series to retrieve
+     * @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSeries(seriesTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesResponse>>;
+    getSeries(seriesTicker: string, includeVolume?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesResponse>>;
     /**
      *  Endpoint for getting data about multiple series with specified filters.  A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). This endpoint allows you to browse and discover available series templates by category.
      * @summary Get Series List
      * @param {string} [category]
      * @param {string} [tags]
      * @param {boolean} [includeProductMetadata]
+     * @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesListResponse>>;
+    getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, includeVolume?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesListResponse>>;
     /**
      *  Endpoint for getting all trades for all markets.  A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
      * @summary Get Trades
@@ -244,10 +250,11 @@ export declare const MarketApiFactory: (configuration?: Configuration, basePath?
      * @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 {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
+     * @param {boolean} [includeLatestBeforeStart] If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by: 1. Finding the most recent real candlestick before start_ts 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts) 3. Setting all OHLC prices to null, and &#x60;previous_price&#x60; to the close price from the real candlestick
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketCandlesticksResponse>;
+    getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, includeLatestBeforeStart?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketCandlesticksResponse>;
     /**
      *  Endpoint for getting the current order book for a specific market.  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.
      * @summary Get Market Orderbook
@@ -281,20 +288,22 @@ export declare const MarketApiFactory: (configuration?: Configuration, basePath?
      *  Endpoint for getting data about a specific series by its ticker.  A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
      * @summary Get Series
      * @param {string} seriesTicker The ticker of the series to retrieve
+     * @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSeries(seriesTicker: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesResponse>;
+    getSeries(seriesTicker: string, includeVolume?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesResponse>;
     /**
      *  Endpoint for getting data about multiple series with specified filters.  A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). This endpoint allows you to browse and discover available series templates by category.
      * @summary Get Series List
      * @param {string} [category]
      * @param {string} [tags]
      * @param {boolean} [includeProductMetadata]
+     * @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesListResponse>;
+    getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, includeVolume?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesListResponse>;
     /**
      *  Endpoint for getting all trades for all markets.  A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
      * @summary Get Trades
@@ -340,10 +349,11 @@ export declare class MarketApi extends BaseAPI {
      * @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 {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
+     * @param {boolean} [includeLatestBeforeStart] If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by: 1. Finding the most recent real candlestick before start_ts 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts) 3. Setting all OHLC prices to null, and &#x60;previous_price&#x60; to the close price from the real candlestick
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketCandlesticksResponse, any, {}>>;
+    getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, includeLatestBeforeStart?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketCandlesticksResponse, any, {}>>;
     /**
      *  Endpoint for getting the current order book for a specific market.  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.
      * @summary Get Market Orderbook
@@ -377,20 +387,22 @@ export declare class MarketApi extends BaseAPI {
      *  Endpoint for getting data about a specific series by its ticker.  A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
      * @summary Get Series
      * @param {string} seriesTicker The ticker of the series to retrieve
+     * @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSeries(seriesTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesResponse, any, {}>>;
+    getSeries(seriesTicker: string, includeVolume?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesResponse, any, {}>>;
     /**
      *  Endpoint for getting data about multiple series with specified filters.  A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). This endpoint allows you to browse and discover available series templates by category.
      * @summary Get Series List
      * @param {string} [category]
      * @param {string} [tags]
      * @param {boolean} [includeProductMetadata]
+     * @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesListResponse, any, {}>>;
+    getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, includeVolume?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesListResponse, any, {}>>;
     /**
      *  Endpoint for getting all trades for all markets.  A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
      * @summary Get Trades