kalshi-typescript 2.1.2 → 3.0.0

package/dist/models/event-data.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.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 { Market } from './market';
+export interface EventData {
+    /**
+     * Unique identifier for this event.
+     */
+    'event_ticker': string;
+    /**
+     * Unique identifier for the series this event belongs to.
+     */
+    'series_ticker': string;
+    /**
+     * Shortened descriptive title for the event.
+     */
+    'sub_title': string;
+    /**
+     * Full title of the event.
+     */
+    'title': string;
+    /**
+     * Specifies how collateral is returned when markets settle (e.g., \'binary\' for standard yes/no markets).
+     */
+    'collateral_return_type': string;
+    /**
+     * If true, only one market in this event can resolve to \'yes\'. If false, multiple markets can resolve to \'yes\'.
+     */
+    'mutually_exclusive': boolean;
+    /**
+     * Event category (deprecated, use series-level category instead).
+     */
+    'category': string;
+    /**
+     * The specific date this event is based on. Only filled when the event uses a date strike (mutually exclusive with strike_period).
+     */
+    'strike_date'?: string | null;
+    /**
+     * The time period this event covers (e.g., \'week\', \'month\'). Only filled when the event uses a period strike (mutually exclusive with strike_date).
+     */
+    'strike_period'?: string | null;
+    /**
+     * Array of markets associated with this event. Only populated when \'with_nested_markets=true\' is specified in the request.
+     */
+    'markets'?: Array<Market>;
+    /**
+     * Whether this event is available to trade on brokers.
+     */
+    'available_on_brokers': boolean;
+    /**
+     * Additional metadata for the event.
+     */
+    'product_metadata': object | null;
+}

package/dist/models/event-data.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/event-position.d.ts

@@ -1,9 +1,9 @@
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -11,43 +11,43 @@
  */
 export interface EventPosition {
     /**
-     * Unique identifier for events.
+     * Unique identifier for events
      */
-    'event_ticker'?: string;
+    'event_ticker': string;
     /**
-     * Total spent on this event in cents.
+     * Total spent on this event in cents
      */
-    'total_cost'?: number;
+    'total_cost': number;
     /**
-     * Total spent on this event in dollars.
+     * US dollar amount as a fixed-point decimal string with exactly 4 decimal places
      */
-    'total_cost_dollars'?: string;
+    'total_cost_dollars': string;
     /**
-     * Cost of the aggregate event position in cents.
+     * Total number of shares traded on this event (including both YES and NO contracts)
      */
-    'event_exposure'?: number;
+    'total_cost_shares': number;
     /**
-     * Cost of the aggregate event position in dollars.
+     * Cost of the aggregate event position in cents
      */
-    'event_exposure_dollars'?: string;
+    'event_exposure': number;
     /**
-     * Locked in profit and loss, in cents.
+     * US dollar amount as a fixed-point decimal string with exactly 4 decimal places
      */
-    'realized_pnl'?: number;
+    'event_exposure_dollars': string;
     /**
-     * Locked in profit and loss, in dollars.
+     * Locked in profit and loss, in cents
      */
-    'realized_pnl_dollars'?: string;
+    'realized_pnl': number;
     /**
-     * Aggregate size of resting orders in contract units.
+     * US dollar amount as a fixed-point decimal string with exactly 4 decimal places
      */
-    'resting_order_count'?: number;
+    'realized_pnl_dollars': string;
     /**
-     * Fees paid on fill orders, in cents.
+     * Fees paid on fill orders, in cents
      */
-    'fees_paid'?: number;
+    'fees_paid': number;
     /**
-     * Fees paid on fill orders, in dollars.
+     * US dollar amount as a fixed-point decimal string with exactly 4 decimal places
      */
-    'fees_paid_dollars'?: string;
+    'fees_paid_dollars': string;
 }

package/dist/models/event-position.js

@@ -2,11 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/exchange-status.d.ts

@@ -1,15 +1,25 @@
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
 export interface ExchangeStatus {
-    'exchange_active'?: boolean;
-    'trading_active'?: boolean;
+    /**
+     * False if the core Kalshi exchange is no longer taking any state changes at all. This includes but is not limited to trading, new users, and transfers. True unless we are under maintenance.
+     */
+    'exchange_active': boolean;
+    /**
+     * True if we are currently permitting trading on the exchange. This is true during trading hours and false outside exchange hours. Kalshi reserves the right to pause at any time in case issues are detected.
+     */
+    'trading_active': boolean;
+    /**
+     * Estimated downtime for the current exchange maintenance window. However, this is not guaranteed and can be extended.
+     */
+    'exchange_estimated_resume_time'?: string | null;
 }

package/dist/models/exchange-status.js

@@ -2,11 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/fill.d.ts

@@ -1,24 +1,83 @@
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
 export interface Fill {
-    'fill_id'?: string;
-    'order_id'?: string;
-    'ticker'?: string;
-    'side'?: FillSideEnum;
-    'action'?: FillActionEnum;
-    'count'?: number;
-    'price'?: number;
-    'is_taker'?: boolean;
+    /**
+     * Unique identifier for this fill
+     */
+    'fill_id': string;
+    /**
+     * Unique identifier for this fill (legacy field name, same as fill_id)
+     */
+    'trade_id': string;
+    /**
+     * Unique identifier for the order that resulted in this fill
+     */
+    'order_id': string;
+    /**
+     * Client-provided identifier for the order that resulted in this fill
+     */
+    'client_order_id'?: string;
+    /**
+     * Unique identifier for the market
+     */
+    'ticker': string;
+    /**
+     * Unique identifier for the market (legacy field name, same as ticker)
+     */
+    'market_ticker': string;
+    /**
+     * Specifies if this is a \'yes\' or \'no\' fill
+     */
+    'side': FillSideEnum;
+    /**
+     * Specifies if this is a buy or sell order
+     */
+    'action': FillActionEnum;
+    /**
+     * Number of contracts bought or sold in this fill
+     */
+    'count': number;
+    /**
+     * Fill price (deprecated - use yes_price or no_price)
+     */
+    'price': number;
+    /**
+     * Fill price for the yes side in cents
+     */
+    'yes_price': number;
+    /**
+     * Fill price for the no side in cents
+     */
+    'no_price': number;
+    /**
+     * Fill price for the yes side in fixed point dollars
+     */
+    'yes_price_fixed': string;
+    /**
+     * Fill price for the no side in fixed point dollars
+     */
+    'no_price_fixed': string;
+    /**
+     * If true, this fill was a taker (removed liquidity from the order book)
+     */
+    'is_taker': boolean;
+    /**
+     * Timestamp when this fill was executed
+     */
     'created_time'?: string;
+    /**
+     * Unix timestamp when this fill was executed (legacy field name)
+     */
+    'ts'?: number;
 }
 export declare const FillSideEnum: {
     readonly Yes: "yes";

package/dist/models/fill.js

@@ -2,11 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/forecast-percentiles-point.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.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 { PercentilePoint } from './percentile-point';
+export interface ForecastPercentilesPoint {
+    /**
+     * The event ticker this forecast is for.
+     */
+    'event_ticker': string;
+    /**
+     * Unix timestamp for the inclusive end of the forecast period.
+     */
+    'end_period_ts': number;
+    /**
+     * Length of the forecast period in minutes.
+     */
+    'period_interval': number;
+    /**
+     * Array of forecast values at different percentiles.
+     */
+    'percentile_points': Array<PercentilePoint>;
+}

package/dist/models/forecast-percentiles-point.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/generate-api-key-request.d.ts

@@ -1,9 +1,9 @@
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/generate-api-key-request.js

@@ -2,11 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/generate-api-key-response.d.ts

@@ -1,9 +1,9 @@
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/generate-api-key-response.js

@@ -2,11 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/get-api-keys-response.d.ts

@@ -1,9 +1,9 @@
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/get-api-keys-response.js

@@ -2,11 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/get-balance-response.d.ts

@@ -1,9 +1,9 @@
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -11,7 +11,15 @@
  */
 export interface GetBalanceResponse {
     /**
-     * Current account balance in cents
+     * Member\'s available balance in cents. This represents the amount available for trading.
+     */
+    'balance': number;
+    /**
+     * Member\'s portfolio value in cents. This is the current value of all positions held.
+     */
+    'portfolio_value': number;
+    /**
+     * Unix timestamp of the last update to the balance.
      */
-    'balance'?: number;
+    'updated_ts': number;
 }

package/dist/models/get-balance-response.js

@@ -2,11 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/get-communications-idresponse.d.ts

@@ -1,9 +1,9 @@
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -11,7 +11,7 @@
  */
 export interface GetCommunicationsIDResponse {
     /**
-     * Communications ID of the user
+     * A public communications ID which is used to identify the user
      */
-    'communications_id'?: string;
+    'communications_id': string;
 }

package/dist/models/get-communications-idresponse.js

@@ -2,11 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/get-event-candlesticks-response.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.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 { MarketCandlestick } from './market-candlestick';
+export interface GetEventCandlesticksResponse {
+    /**
+     * Array of market tickers in the event.
+     */
+    'market_tickers': Array<string>;
+    /**
+     * Array of market candlestick arrays, one for each market in the event.
+     */
+    'market_candlesticks': Array<Array<MarketCandlestick>>;
+    /**
+     * Adjusted end timestamp if the requested candlesticks would be larger than maxAggregateCandidates.
+     */
+    'adjusted_end_ts': number;
+}

package/dist/models/get-event-candlesticks-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/get-event-forecast-percentiles-history-response.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.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 { ForecastPercentilesPoint } from './forecast-percentiles-point';
+export interface GetEventForecastPercentilesHistoryResponse {
+    /**
+     * Array of forecast percentile data points over time.
+     */
+    'forecast_history': Array<ForecastPercentilesPoint>;
+}

package/dist/models/get-event-forecast-percentiles-history-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });