kalshi-typescript 3.5.0 → 3.7.0

package/models/create-order-group-response.ts

@@ -0,0 +1,23 @@
+/* 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.7.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 CreateOrderGroupResponse {
+    /**
+     * The unique identifier for the created order group
+     */
+    'order_group_id': string;
+}
+

package/models/create-order-request.ts

@@ -0,0 +1,90 @@
+/* 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.7.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 { SelfTradePreventionType } from './self-trade-prevention-type';
+
+export interface CreateOrderRequest {
+    'ticker': string;
+    'client_order_id'?: string;
+    'side': CreateOrderRequestSideEnum;
+    'action': CreateOrderRequestActionEnum;
+    /**
+     * Order quantity in contracts (whole contracts only). Provide count or count_fp; if both provided they must match.
+     */
+    'count'?: number;
+    /**
+     * Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match.
+     */
+    'count_fp'?: string;
+    'yes_price'?: number;
+    'no_price'?: number;
+    /**
+     * US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
+     */
+    'yes_price_dollars'?: string;
+    /**
+     * US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
+     */
+    'no_price_dollars'?: string;
+    'expiration_ts'?: number;
+    'time_in_force'?: CreateOrderRequestTimeInForceEnum;
+    /**
+     * Maximum cost in cents. When specified, the order will automatically have Fill-or-Kill (FoK) behavior.
+     */
+    'buy_max_cost'?: number;
+    'post_only'?: boolean;
+    'reduce_only'?: boolean;
+    /**
+     * Deprecated: Use reduce_only instead. Only accepts value of 0.
+     */
+    'sell_position_floor'?: number;
+    'self_trade_prevention_type'?: SelfTradePreventionType;
+    /**
+     * The order group this order is part of
+     */
+    'order_group_id'?: string;
+    /**
+     * If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason.
+     */
+    'cancel_order_on_pause'?: boolean;
+    /**
+     * The subaccount number to use for this order. 0 is the primary subaccount.
+     */
+    'subaccount'?: number;
+}
+
+export const CreateOrderRequestSideEnum = {
+    Yes: 'yes',
+    No: 'no'
+} as const;
+
+export type CreateOrderRequestSideEnum = typeof CreateOrderRequestSideEnum[keyof typeof CreateOrderRequestSideEnum];
+export const CreateOrderRequestActionEnum = {
+    Buy: 'buy',
+    Sell: 'sell'
+} as const;
+
+export type CreateOrderRequestActionEnum = typeof CreateOrderRequestActionEnum[keyof typeof CreateOrderRequestActionEnum];
+export const CreateOrderRequestTimeInForceEnum = {
+    FillOrKill: 'fill_or_kill',
+    GoodTillCanceled: 'good_till_canceled',
+    ImmediateOrCancel: 'immediate_or_cancel'
+} as const;
+
+export type CreateOrderRequestTimeInForceEnum = typeof CreateOrderRequestTimeInForceEnum[keyof typeof CreateOrderRequestTimeInForceEnum];
+
+

package/models/create-order-response.ts

@@ -0,0 +1,23 @@
+/* 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.7.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 { Order } from './order';
+
+export interface CreateOrderResponse {
+    'order': Order;
+}
+

package/models/create-quote-request.ts

@@ -0,0 +1,39 @@
+/* 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.7.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 CreateQuoteRequest {
+    /**
+     * The ID of the RFQ to quote on
+     */
+    'rfq_id': string;
+    /**
+     * US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
+     */
+    'yes_bid': string;
+    /**
+     * US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
+     */
+    'no_bid': string;
+    /**
+     * Whether to rest the remainder of the quote after execution
+     */
+    'rest_remainder': boolean;
+    /**
+     * Optional subaccount number to place the quote under (0 for primary, 1-32 for subaccounts)
+     */
+    'subaccount'?: number;
+}
+

package/models/create-quote-response.ts

@@ -0,0 +1,23 @@
+/* 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.7.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 CreateQuoteResponse {
+    /**
+     * The ID of the newly created quote
+     */
+    'id': string;
+}
+

package/models/create-rfqrequest.ts

@@ -0,0 +1,56 @@
+/* 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.7.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 CreateRFQRequest {
+    /**
+     * The ticker of the market for which to create an RFQ
+     */
+    'market_ticker': string;
+    /**
+     * The number of contracts for the RFQ. Whole contracts only. Contracts may be provided via contracts or contracts_fp; if both provided they must match.
+     */
+    'contracts'?: number;
+    /**
+     * Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match.
+     */
+    'contracts_fp'?: string;
+    /**
+     * DEPRECATED: The target cost for the RFQ in centi-cents. Use target_cost_dollars instead.
+     * @deprecated
+     */
+    'target_cost_centi_cents'?: number;
+    /**
+     * US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
+     */
+    'target_cost_dollars'?: string;
+    /**
+     * Whether to rest the remainder of the RFQ after execution
+     */
+    'rest_remainder': boolean;
+    /**
+     * Whether to delete existing RFQs as part of this RFQ\'s creation
+     */
+    'replace_existing'?: boolean;
+    /**
+     * The subtrader to create the RFQ for (FCM members only)
+     */
+    'subtrader_id'?: string;
+    /**
+     * The subaccount number to create the RFQ for (direct members only; 0 for primary, 1-32 for subaccounts)
+     */
+    'subaccount'?: number;
+}
+

package/models/create-rfqresponse.ts

@@ -0,0 +1,23 @@
+/* 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.7.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 CreateRFQResponse {
+    /**
+     * The ID of the newly created RFQ
+     */
+    'id': string;
+}
+

package/models/create-subaccount-response.ts

@@ -0,0 +1,23 @@
+/* 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.7.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 CreateSubaccountResponse {
+    /**
+     * The sequential number assigned to this subaccount (1-32).
+     */
+    'subaccount_number': number;
+}
+

package/models/daily-schedule.ts

@@ -0,0 +1,27 @@
+/* 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.7.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 DailySchedule {
+    /**
+     * Opening time in ET (Eastern Time) format HH:MM.
+     */
+    'open_time': string;
+    /**
+     * Closing time in ET (Eastern Time) format HH:MM.
+     */
+    'close_time': string;
+}
+

package/models/decrease-order-request.ts

@@ -0,0 +1,39 @@
+/* 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.7.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 DecreaseOrderRequest {
+    /**
+     * Optional subaccount number to use for this decrease (0 for primary, 1-32 for subaccounts)
+     */
+    'subaccount'?: number;
+    /**
+     * Number of contracts to reduce by (whole contracts only). Reduce-by may be provided via reduce_by or reduce_by_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided.
+     */
+    'reduce_by'?: number;
+    /**
+     * Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match.
+     */
+    'reduce_by_fp'?: string;
+    /**
+     * Number of contracts to reduce to (whole contracts only). Reduce-to may be provided via reduce_to or reduce_to_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided.
+     */
+    'reduce_to'?: number;
+    /**
+     * Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match.
+     */
+    'reduce_to_fp'?: string;
+}
+

package/models/decrease-order-response.ts

@@ -0,0 +1,23 @@
+/* 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.7.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 { Order } from './order';
+
+export interface DecreaseOrderResponse {
+    'order': Order;
+}
+

package/models/error-response.ts

@@ -0,0 +1,35 @@
+/* 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.7.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 ErrorResponse {
+    /**
+     * Error code
+     */
+    'code'?: string;
+    /**
+     * Human-readable error message
+     */
+    'message'?: string;
+    /**
+     * Additional details about the error, if available
+     */
+    'details'?: string;
+    /**
+     * The name of the service that generated the error
+     */
+    'service'?: string;
+}
+

package/models/event-data.ts

@@ -0,0 +1,70 @@
+/* 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.7.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 { 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/models/event-position.ts

@@ -0,0 +1,63 @@
+/* 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.7.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 EventPosition {
+    /**
+     * Unique identifier for events
+     */
+    'event_ticker': string;
+    /**
+     * Total spent on this event in cents
+     */
+    'total_cost': number;
+    /**
+     * US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
+     */
+    'total_cost_dollars': string;
+    /**
+     * Total number of shares traded on this event (including both YES and NO contracts)
+     */
+    'total_cost_shares': number;
+    /**
+     * Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match.
+     */
+    'total_cost_shares_fp': string;
+    /**
+     * Cost of the aggregate event position in cents
+     */
+    'event_exposure': number;
+    /**
+     * US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
+     */
+    'event_exposure_dollars': string;
+    /**
+     * Locked in profit and loss, in cents
+     */
+    'realized_pnl': number;
+    /**
+     * US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
+     */
+    'realized_pnl_dollars': string;
+    /**
+     * Fees paid on fill orders, in cents
+     */
+    'fees_paid': number;
+    /**
+     * US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
+     */
+    'fees_paid_dollars': string;
+}
+

package/models/exchange-instance.ts

@@ -0,0 +1,29 @@
+/* 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.7.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 exchange instance type
+ */
+
+export const ExchangeInstance = {
+    EventContract: 'event_contract',
+    Margined: 'margined'
+} as const;
+
+export type ExchangeInstance = typeof ExchangeInstance[keyof typeof ExchangeInstance];
+
+
+

package/models/exchange-status.ts

@@ -0,0 +1,31 @@
+/* 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.7.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 ExchangeStatus {
+    /**
+     * 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;
+}
+