kalshi-typescript 2.1.3 → 3.0.0

package/dist/models/rfq.d.ts

@@ -1,26 +1,75 @@
 /**
- * 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.
  */
+import type { MveSelectedLeg } from './mve-selected-leg';
 export interface RFQ {
-    'rfq_id'?: string;
-    'requester_id'?: string;
-    'ticker'?: string;
-    'side'?: RFQSideEnum;
-    'size'?: number;
-    'status'?: string;
-    'created_ts'?: string;
-    'expires_ts'?: string;
+    /**
+     * Unique identifier for the RFQ
+     */
+    'id': string;
+    /**
+     * Public communications ID of the RFQ creator
+     */
+    'creator_id': string;
+    /**
+     * The ticker of the market this RFQ is for
+     */
+    'market_ticker': string;
+    /**
+     * Number of contracts requested in the RFQ
+     */
+    'contracts': number;
+    /**
+     * Total value of the RFQ in centi-cents
+     */
+    'target_cost_centi_cents'?: number;
+    /**
+     * Current status of the RFQ (open, closed)
+     */
+    'status': RFQStatusEnum;
+    /**
+     * Timestamp when the RFQ was created
+     */
+    'created_ts': string;
+    /**
+     * Ticker of the MVE collection this market belongs to
+     */
+    'mve_collection_ticker'?: string;
+    /**
+     * Selected legs for the MVE collection
+     */
+    'mve_selected_legs'?: Array<MveSelectedLeg>;
+    /**
+     * Whether to rest the remainder of the RFQ after execution
+     */
+    'rest_remainder'?: boolean;
+    /**
+     * Reason for RFQ cancellation if cancelled
+     */
+    'cancellation_reason'?: string;
+    /**
+     * User ID of the RFQ creator (private field)
+     */
+    'creator_user_id'?: string;
+    /**
+     * Timestamp when the RFQ was cancelled
+     */
+    'cancelled_ts'?: string;
+    /**
+     * Timestamp when the RFQ was last updated
+     */
+    'updated_ts'?: string;
 }
-export declare const RFQSideEnum: {
-    readonly Yes: "yes";
-    readonly No: "no";
+export declare const RFQStatusEnum: {
+    readonly Open: "open";
+    readonly Closed: "closed";
 };
-export type RFQSideEnum = typeof RFQSideEnum[keyof typeof RFQSideEnum];
+export type RFQStatusEnum = typeof RFQStatusEnum[keyof typeof RFQStatusEnum];

package/dist/models/rfq.js

@@ -2,19 +2,19 @@
 /* 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
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RFQSideEnum = void 0;
-exports.RFQSideEnum = {
-    Yes: 'yes',
-    No: 'no'
+exports.RFQStatusEnum = void 0;
+exports.RFQStatusEnum = {
+    Open: 'open',
+    Closed: 'closed'
 };

package/dist/models/schedule.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { MaintenanceWindow } from './maintenance-window';
+import type { WeeklySchedule } from './weekly-schedule';
+export interface Schedule {
+    /**
+     * The standard operating hours of the exchange. All times are expressed in ET. Outside of these times trading will be unavailable.
+     */
+    'standard_hours': Array<WeeklySchedule>;
+    /**
+     * Scheduled maintenance windows, during which the exchange may be unavailable.
+     */
+    'maintenance_windows': Array<MaintenanceWindow>;
+}

package/dist/models/schedule.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/scope-list.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+export interface ScopeList {
+    /**
+     * List of scopes
+     */
+    'scopes': Array<string>;
+}

package/dist/models/scope-list.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/self-trade-prevention-type.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+/**
+ * The self-trade prevention type for orders
+ */
+export declare const SelfTradePreventionType: {
+    readonly TakerAtCross: "taker_at_cross";
+    readonly Maker: "maker";
+};
+export type SelfTradePreventionType = typeof SelfTradePreventionType[keyof typeof SelfTradePreventionType];

package/dist/models/self-trade-prevention-type.js

@@ -0,0 +1,23 @@
+"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 });
+exports.SelfTradePreventionType = void 0;
+/**
+ * The self-trade prevention type for orders
+ */
+exports.SelfTradePreventionType = {
+    TakerAtCross: 'taker_at_cross',
+    Maker: 'maker'
+};

package/dist/models/series-fee-change.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.
+ */
+export interface SeriesFeeChange {
+    /**
+     * Unique identifier for this fee change
+     */
+    'id': string;
+    /**
+     * Series ticker this fee change applies to
+     */
+    'series_ticker': string;
+    /**
+     * New fee type for the series
+     */
+    'fee_type': SeriesFeeChangeFeeTypeEnum;
+    /**
+     * New fee multiplier for the series
+     */
+    'fee_multiplier': number;
+    /**
+     * Timestamp when this fee change is scheduled to take effect
+     */
+    'scheduled_ts': string;
+}
+export declare const SeriesFeeChangeFeeTypeEnum: {
+    readonly Quadratic: "quadratic";
+    readonly QuadraticWithMakerFees: "quadratic_with_maker_fees";
+    readonly Flat: "flat";
+};
+export type SeriesFeeChangeFeeTypeEnum = typeof SeriesFeeChangeFeeTypeEnum[keyof typeof SeriesFeeChangeFeeTypeEnum];

package/dist/models/series-fee-change.js

@@ -0,0 +1,21 @@
+"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 });
+exports.SeriesFeeChangeFeeTypeEnum = void 0;
+exports.SeriesFeeChangeFeeTypeEnum = {
+    Quadratic: 'quadratic',
+    QuadraticWithMakerFees: 'quadratic_with_maker_fees',
+    Flat: 'flat'
+};

package/dist/models/series.d.ts

@@ -1,20 +1,68 @@
 /**
- * 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.
  */
+import type { SettlementSource } from './settlement-source';
 export interface Series {
     /**
-     * The ticker symbol for this series
+     * Ticker that identifies this series.
+     */
+    'ticker': string;
+    /**
+     * Description of the frequency of the series. There is no fixed value set here, but will be something human-readable like weekly, daily, one-off.
+     */
+    'frequency': string;
+    /**
+     * Title describing the series. For full context use you should use this field with the title field of the events belonging to this series.
+     */
+    'title': string;
+    /**
+     * Category specifies the category which this series belongs to.
+     */
+    'category': string;
+    /**
+     * Tags specifies the subjects that this series relates to, multiple series from different categories can have the same tags.
+     */
+    'tags': Array<string>;
+    /**
+     * SettlementSources specifies the official sources used for the determination of markets within the series. Methodology is defined in the rulebook.
+     */
+    'settlement_sources': Array<SettlementSource>;
+    /**
+     * ContractUrl provides a direct link to the original filing of the contract which underlies the series.
+     */
+    'contract_url': string;
+    /**
+     * ContractTermsUrl is the URL to the current terms of the contract underlying the series.
+     */
+    'contract_terms_url': string;
+    /**
+     * Internal product metadata of the series.
+     */
+    'product_metadata'?: object | null;
+    /**
+     * FeeType is a string representing the series\' fee structure. Fee structures can be found at https://kalshi.com/docs/kalshi-fee-schedule.pdf. \'quadratic\' is described by the General Trading Fees Table, \'quadratic_with_maker_fees\' is described by the General Trading Fees Table with maker fees described in the Maker Fees section, \'flat\' is described by the Specific Trading Fees Table.
+     */
+    'fee_type': SeriesFeeTypeEnum;
+    /**
+     * FeeMultiplier is a floating point multiplier applied to the fee calculations.
+     */
+    'fee_multiplier': number;
+    /**
+     * AdditionalProhibitions is a list of additional trading prohibitions for this series.
      */
-    'ticker'?: string;
-    'title'?: string;
-    'category'?: string;
-    'status'?: string;
+    'additional_prohibitions': Array<string>;
 }
+export declare const SeriesFeeTypeEnum: {
+    readonly Quadratic: "quadratic";
+    readonly QuadraticWithMakerFees: "quadratic_with_maker_fees";
+    readonly Flat: "flat";
+};
+export type SeriesFeeTypeEnum = typeof SeriesFeeTypeEnum[keyof typeof SeriesFeeTypeEnum];

package/dist/models/series.js

@@ -2,14 +2,20 @@
 /* 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
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeriesFeeTypeEnum = void 0;
+exports.SeriesFeeTypeEnum = {
+    Quadratic: 'quadratic',
+    QuadraticWithMakerFees: 'quadratic_with_maker_fees',
+    Flat: 'flat'
+};

package/dist/models/settlement-source.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+export interface SettlementSource {
+    /**
+     * Name of the settlement source
+     */
+    'name'?: string;
+    /**
+     * URL to the settlement source
+     */
+    'url'?: string;
+}

package/dist/models/settlement-source.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/settlement.d.ts

@@ -1,24 +1,60 @@
 /**
- * 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 Settlement {
-    'ticker'?: string;
-    'result'?: SettlementResultEnum;
-    'yes_count'?: number;
-    'no_count'?: number;
-    'revenue'?: number;
-    'settled_time'?: string;
+    /**
+     * The ticker symbol of the market that was settled.
+     */
+    'ticker': string;
+    /**
+     * The outcome of the market settlement. \'yes\' = market resolved to YES, \'no\' = market resolved to NO, \'scalar\' = scalar market settled at a specific value, \'void\' = market was voided/cancelled and all positions returned at original cost.
+     */
+    'market_result': SettlementMarketResultEnum;
+    /**
+     * Number of YES contracts owned at the time of settlement.
+     */
+    'yes_count': number;
+    /**
+     * Total cost basis of all YES contracts in cents.
+     */
+    'yes_total_cost': number;
+    /**
+     * Number of NO contracts owned at the time of settlement.
+     */
+    'no_count': number;
+    /**
+     * Total cost basis of all NO contracts in cents.
+     */
+    'no_total_cost': number;
+    /**
+     * Total revenue earned from this settlement in cents (winning contracts pay out 100 cents each).
+     */
+    'revenue': number;
+    /**
+     * Timestamp when the market was settled and payouts were processed.
+     */
+    'settled_time': string;
+    /**
+     * Total fees paid in fixed point dollars.
+     */
+    'fee_cost': string;
+    /**
+     * Payout of a single yes contract in cents.
+     */
+    'value'?: number | null;
 }
-export declare const SettlementResultEnum: {
+export declare const SettlementMarketResultEnum: {
     readonly Yes: "yes";
     readonly No: "no";
+    readonly Scalar: "scalar";
+    readonly Void: "void";
 };
-export type SettlementResultEnum = typeof SettlementResultEnum[keyof typeof SettlementResultEnum];
+export type SettlementMarketResultEnum = typeof SettlementMarketResultEnum[keyof typeof SettlementMarketResultEnum];

package/dist/models/settlement.js

@@ -2,19 +2,21 @@
 /* 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
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SettlementResultEnum = void 0;
-exports.SettlementResultEnum = {
+exports.SettlementMarketResultEnum = void 0;
+exports.SettlementMarketResultEnum = {
     Yes: 'yes',
-    No: 'no'
+    No: 'no',
+    Scalar: 'scalar',
+    Void: 'void'
 };

package/dist/models/sport-filter-details.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { ScopeList } from './scope-list';
+export interface SportFilterDetails {
+    /**
+     * List of scopes available for this sport
+     */
+    'scopes': Array<string>;
+    /**
+     * Mapping of competitions to their scope lists
+     */
+    'competitions': {
+        [key: string]: ScopeList;
+    };
+}

package/dist/models/sport-filter-details.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/structured-target.d.ts

@@ -1,16 +1,37 @@
 /**
- * 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 StructuredTarget {
-    'structured_target_id'?: string;
-    'title'?: string;
-    'status'?: string;
+    /**
+     * Unique identifier for the structured target.
+     */
+    'id'?: string;
+    /**
+     * Name of the structured target.
+     */
+    'name'?: string;
+    /**
+     * Type of the structured target.
+     */
+    'type'?: string;
+    /**
+     * Additional details about the structured target. Contains flexible JSON data specific to the target type.
+     */
+    'details'?: object;
+    /**
+     * External source identifier for the structured target, if available (e.g., third-party data provider ID).
+     */
+    'source_id'?: string;
+    /**
+     * Timestamp when this structured target was last updated.
+     */
+    'last_updated_ts'?: string;
 }

package/dist/models/structured-target.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