kalshi-typescript 2.1.3 → 3.3.0

package/dist/esm/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.3.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/esm/models/forecast-percentiles-point.js

@@ -0,0 +1,14 @@
+/* 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.3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/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.3.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
@@ -14,4 +14,8 @@ export interface GenerateApiKeyRequest {
      * Name for the API key. This helps identify the key\'s purpose
      */
     'name': string;
+    /**
+     * List of scopes to grant to the API key. Valid values are \'read\' and \'write\'. If \'write\' is included, \'read\' must also be included. Defaults to full access ([\'read\', \'write\']) if not provided.
+     */
+    'scopes'?: Array<string>;
 }

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

@@ -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: 3.3.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/esm/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.3.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/esm/models/generate-api-key-response.js

@@ -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: 3.3.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/esm/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.3.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/esm/models/get-api-keys-response.js

@@ -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: 3.3.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/esm/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.3.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/esm/models/get-balance-response.js

@@ -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: 3.3.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/esm/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.3.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/esm/models/get-communications-idresponse.js

@@ -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: 3.3.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/esm/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.3.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/esm/models/get-event-candlesticks-response.js

@@ -0,0 +1,14 @@
+/* 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.3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/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.3.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/esm/models/get-event-forecast-percentiles-history-response.js

@@ -0,0 +1,14 @@
+/* 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.3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/get-event-metadata-response.d.ts

@@ -1,14 +1,39 @@
 /**
- * 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.3.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.
  */
+import type { MarketMetadata } from './market-metadata';
+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/dist/esm/models/get-event-metadata-response.js

@@ -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: 3.3.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/esm/models/get-event-response.d.ts

@@ -1,17 +1,20 @@
 /**
- * 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.3.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.
  */
-import type { Event } from './event';
+import type { EventData } from './event-data';
 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/dist/esm/models/get-event-response.js

@@ -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: 3.3.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/esm/models/get-events-candlesticks-response-events-inner.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: 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.
+ */
+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/accept-quote-request.ts → dist/esm/models/get-events-candlesticks-response-events-inner.js}

@@ -1,20 +1,14 @@
 /* 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
+ *
  *
  * 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 AcceptQuoteRequest {
-    'size'?: number;
-}
-
+export {};

package/dist/esm/models/get-events-candlesticks-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: 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.
+ */
+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/decrease-order-request.ts → dist/esm/models/get-events-candlesticks-response.js}

@@ -1,20 +1,14 @@
 /* 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
+ *
  *
  * 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 DecreaseOrderRequest {
-    'reduce_by': number;
-}
-
+export {};

package/dist/esm/models/get-events-response.d.ts

@@ -1,16 +1,27 @@
 /**
- * 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.3.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.
  */
-import type { Event } from './event';
+import type { EventData } from './event-data';
+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/dist/esm/models/get-events-response.js

@@ -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: 3.3.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/esm/models/get-exchange-announcements-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.3.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,5 +11,8 @@
  */
 import type { Announcement } from './announcement';
 export interface GetExchangeAnnouncementsResponse {
-    'announcements'?: Array<Announcement>;
+    /**
+     * A list of exchange-wide announcements.
+     */
+    'announcements': Array<Announcement>;
 }

package/dist/esm/models/get-exchange-announcements-response.js

@@ -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: 3.3.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/esm/models/get-exchange-schedule-response.d.ts

@@ -1,15 +1,15 @@
 /**
- * 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.3.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.
  */
-import type { GetExchangeScheduleResponseSchedule } from './get-exchange-schedule-response-schedule';
+import type { Schedule } from './schedule';
 export interface GetExchangeScheduleResponse {
-    'schedule'?: GetExchangeScheduleResponseSchedule;
+    'schedule': Schedule;
 }