kalshi-typescript 2.1.3 → 3.0.0

package/models/event-position.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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
@@ -16,44 +16,44 @@
 
 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/models/event.ts

@@ -33,5 +33,3 @@ export const EventStatusEnum = {
 } as const;
 
 export type EventStatusEnum = typeof EventStatusEnum[keyof typeof EventStatusEnum];
-
-

package/models/exchange-status.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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
@@ -15,7 +15,17 @@
 
 
 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/models/fill.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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
@@ -15,15 +15,74 @@
 
 
 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 const FillSideEnum = {

package/models/forecast-percentiles-point.ts

@@ -0,0 +1,38 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/generate-api-key-request.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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

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

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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

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

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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

package/models/get-balance-response.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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
@@ -16,8 +16,16 @@
 
 export interface GetBalanceResponse {
     /**
-     * Current account balance in cents
+     * Member\'s available balance in cents. This represents the amount available for trading.
      */
-    'balance'?: number;
+    '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.
+     */
+    'updated_ts': number;
 }
 

package/models/get-communications-idresponse.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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
@@ -16,8 +16,8 @@
 
 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/models/get-event-candlesticks-response.ts

@@ -0,0 +1,34 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/get-event-forecast-percentiles-history-response.ts

@@ -0,0 +1,26 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ForecastPercentilesPoint } from './forecast-percentiles-point';
+
+export interface GetEventForecastPercentilesHistoryResponse {
+    /**
+     * Array of forecast percentile data points over time.
+     */
+    'forecast_history': Array<ForecastPercentilesPoint>;
+}
+

package/models/get-event-metadata-response.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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
@@ -13,8 +13,37 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MarketMetadata } from './market-metadata';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SettlementSource } from './settlement-source';
 
 export interface GetEventMetadataResponse {
-    'metadata'?: object;
+    /**
+     * A path to an image that represents this event.
+     */
+    'image_url': string;
+    /**
+     * A path to an image that represents the image of the featured market.
+     */
+    'featured_image_url'?: string;
+    /**
+     * Metadata for the markets in this event.
+     */
+    'market_details': Array<MarketMetadata>;
+    /**
+     * A list of settlement sources for this event.
+     */
+    'settlement_sources': Array<SettlementSource>;
+    /**
+     * Event competition.
+     */
+    'competition'?: string | null;
+    /**
+     * Event scope, based on the competition.
+     */
+    'competition_scope'?: string | null;
 }
 

package/models/get-event-response.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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
@@ -15,13 +15,16 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { Event } from './event';
+import type { EventData } from './event-data';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { Market } from './market';
 
 export interface GetEventResponse {
-    'event'?: Event;
-    'markets'?: Array<Market>;
+    'event': EventData;
+    /**
+     * Data for the markets in this event. This field is deprecated in favour of the \"markets\" field inside the event. Which will be filled with the same value if you use the query parameter \"with_nested_markets=true\".
+     */
+    'markets': Array<Market>;
 }
 

package/models/get-events-candlesticks-response-events-inner.ts

@@ -0,0 +1,38 @@
+/* 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: 2.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MarketCandlestick } from './market-candlestick';
+
+export interface GetEventsCandlesticksResponseEventsInner {
+    /**
+     * The event ticker
+     */
+    'event_ticker': string;
+    /**
+     * 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/models/get-events-candlesticks-response.ts

@@ -0,0 +1,26 @@
+/* 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: 2.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { GetEventsCandlesticksResponseEventsInner } from './get-events-candlesticks-response-events-inner';
+
+export interface GetEventsCandlesticksResponse {
+    /**
+     * Array of event candlestick responses, one for each event ticker.
+     */
+    'events': Array<GetEventsCandlesticksResponseEventsInner>;
+}
+

package/models/get-events-response.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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
@@ -15,10 +15,23 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { Event } from './event';
+import type { EventData } from './event-data';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Milestone } from './milestone';
 
 export interface GetEventsResponse {
-    'events'?: Array<Event>;
-    'cursor'?: string;
+    /**
+     * Array of events matching the query criteria.
+     */
+    'events': Array<EventData>;
+    /**
+     * Array of milestones related to the events.
+     */
+    'milestones'?: Array<Milestone>;
+    /**
+     * Pagination cursor for the next page. Empty if there are no more results.
+     */
+    'cursor': string;
 }
 

package/models/get-exchange-announcements-response.ts

@@ -1,11 +1,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: 2.0.0
- * Contact: support@kalshi.com
+ * 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
@@ -18,6 +18,9 @@
 import type { Announcement } from './announcement';
 
 export interface GetExchangeAnnouncementsResponse {
-    'announcements'?: Array<Announcement>;
+    /**
+     * A list of exchange-wide announcements.
+     */
+    'announcements': Array<Announcement>;
 }