kalshi-typescript 3.6.0 → 3.7.0

package/models/multivariate-event-collection.ts

@@ -0,0 +1,78 @@
+/* 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 { AssociatedEvent } from './associated-event';
+
+export interface MultivariateEventCollection {
+    /**
+     * Unique identifier for the collection.
+     */
+    'collection_ticker': string;
+    /**
+     * Series associated with the collection. Events produced in the collection will be associated with this series.
+     */
+    'series_ticker': string;
+    /**
+     * Title of the collection.
+     */
+    'title': string;
+    /**
+     * Short description of the collection.
+     */
+    'description': string;
+    /**
+     * The open date of the collection. Before this time, the collection cannot be interacted with.
+     */
+    'open_date': string;
+    /**
+     * The close date of the collection. After this time, the collection cannot be interacted with.
+     */
+    'close_date': string;
+    /**
+     * List of events with their individual configuration.
+     */
+    'associated_events': Array<AssociatedEvent>;
+    /**
+     * [DEPRECATED - Use associated_events instead] A list of events associated with the collection. Markets in these events can be passed as inputs to the Lookup and Create endpoints.
+     */
+    'associated_event_tickers': Array<string>;
+    /**
+     * Whether the collection is ordered. If true, the order of markets passed into Lookup/Create affects the output. If false, the order does not matter.
+     */
+    'is_ordered': boolean;
+    /**
+     * [DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create.
+     */
+    'is_single_market_per_event': boolean;
+    /**
+     * [DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of \'yes\' may be used.
+     */
+    'is_all_yes': boolean;
+    /**
+     * The minimum number of markets that must be passed into Lookup/Create (inclusive).
+     */
+    'size_min': number;
+    /**
+     * The maximum number of markets that must be passed into Lookup/Create (inclusive).
+     */
+    'size_max': number;
+    /**
+     * A functional description of the collection describing how inputs affect the output.
+     */
+    'functional_description': string;
+}
+

package/models/mve-selected-leg.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 MveSelectedLeg {
+    /**
+     * Unique identifier for the selected event
+     */
+    'event_ticker'?: string;
+    /**
+     * Unique identifier for the selected market
+     */
+    'market_ticker'?: string;
+    /**
+     * The side of the selected market
+     */
+    'side'?: 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_settlement_value_dollars'?: string;
+}
+

package/models/order-group.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 OrderGroup {
+    /**
+     * Unique identifier for the order group
+     */
+    'id': string;
+    /**
+     * Current maximum contracts allowed over a rolling 15-second window (whole contracts only).
+     */
+    'contracts_limit'?: 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_limit_fp'?: string;
+    /**
+     * Whether auto-cancel is enabled for this order group
+     */
+    'is_auto_cancel_enabled': boolean;
+}
+

package/models/order-queue-position.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 OrderQueuePosition {
+    /**
+     * The order ID
+     */
+    'order_id': string;
+    /**
+     * The market ticker
+     */
+    'market_ticker': string;
+    /**
+     * The position of the order in the queue
+     */
+    'queue_position': 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.
+     */
+    'queue_position_fp'?: string;
+}
+

package/models/order-status.ts

@@ -0,0 +1,30 @@
+/* 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 status of an order
+ */
+
+export const OrderStatus = {
+    Resting: 'resting',
+    Canceled: 'canceled',
+    Executed: 'executed'
+} as const;
+
+export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
+
+
+

package/models/order.ts

@@ -0,0 +1,142 @@
+/* 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 { OrderStatus } from './order-status';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SelfTradePreventionType } from './self-trade-prevention-type';
+
+export interface Order {
+    'order_id': string;
+    /**
+     * Unique identifier for users
+     */
+    'user_id': string;
+    'client_order_id': string;
+    'ticker': string;
+    'side': OrderSideEnum;
+    'action': OrderActionEnum;
+    'type': OrderTypeEnum;
+    'status': OrderStatus;
+    '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;
+    /**
+     * The number of contracts that have been filled
+     */
+    'fill_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.
+     */
+    'fill_count_fp': string;
+    'remaining_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.
+     */
+    'remaining_count_fp': string;
+    /**
+     * The initial size of the order (contract units)
+     */
+    'initial_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.
+     */
+    'initial_count_fp': string;
+    /**
+     * Fees paid on filled taker contracts, in cents
+     */
+    'taker_fees': number;
+    /**
+     * Fees paid on filled maker contracts, in cents
+     */
+    'maker_fees': number;
+    /**
+     * The cost of filled taker orders in cents
+     */
+    'taker_fill_cost': number;
+    /**
+     * The cost of filled maker orders in cents
+     */
+    'maker_fill_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.
+     */
+    'taker_fill_cost_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.
+     */
+    'maker_fill_cost_dollars': string;
+    /**
+     * **DEPRECATED**: This field is deprecated and will always return 0. Please use the GET /portfolio/orders/{order_id}/queue_position endpoint instead
+     */
+    'queue_position': 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.
+     */
+    'taker_fees_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.
+     */
+    'maker_fees_dollars'?: string;
+    'expiration_time'?: string | null;
+    'created_time'?: string | null;
+    /**
+     * The last update to an order (modify, cancel, fill)
+     */
+    'last_update_time'?: string | null;
+    'self_trade_prevention_type'?: SelfTradePreventionType;
+    /**
+     * The order group this order is part of
+     */
+    'order_group_id'?: string | null;
+    /**
+     * 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;
+    /**
+     * Subaccount number (0 for primary, 1-32 for subaccounts). Present for direct users.
+     */
+    'subaccount_number'?: number | null;
+}
+
+export const OrderSideEnum = {
+    Yes: 'yes',
+    No: 'no'
+} as const;
+
+export type OrderSideEnum = typeof OrderSideEnum[keyof typeof OrderSideEnum];
+export const OrderActionEnum = {
+    Buy: 'buy',
+    Sell: 'sell'
+} as const;
+
+export type OrderActionEnum = typeof OrderActionEnum[keyof typeof OrderActionEnum];
+export const OrderTypeEnum = {
+    Limit: 'limit',
+    Market: 'market'
+} as const;
+
+export type OrderTypeEnum = typeof OrderTypeEnum[keyof typeof OrderTypeEnum];
+
+

package/models/orderbook-count-fp.ts

@@ -0,0 +1,24 @@
+/* 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.
+ */
+
+
+
+/**
+ * Orderbook with fixed-point contract counts (fp) in all dollar price levels.
+ */
+export interface OrderbookCountFp {
+    'yes_dollars': Array<Array<string>>;
+    'no_dollars': Array<Array<string>>;
+}
+

package/models/orderbook.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.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.
+ */
+
+
+
+/**
+ * Legacy integer-count orderbook (will be deprecated). Prefer OrderbookCountFp / orderbook_fp for fixed-point contract counts.
+ */
+export interface Orderbook {
+    'true'?: Array<Array<number>>;
+    'false'?: Array<Array<number>>;
+    'yes_dollars': Array<Array<string>>;
+    'no_dollars': Array<Array<string>>;
+}
+

package/models/percentile-point.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 PercentilePoint {
+    /**
+     * The percentile value (0-10000).
+     */
+    'percentile': number;
+    /**
+     * The raw numerical forecast value.
+     */
+    'raw_numerical_forecast': number;
+    /**
+     * The processed numerical forecast value.
+     */
+    'numerical_forecast': number;
+    /**
+     * The human-readable formatted forecast value.
+     */
+    'formatted_forecast': string;
+}
+

package/models/price-distribution-historical.ts

@@ -0,0 +1,43 @@
+/* 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 PriceDistributionHistorical {
+    /**
+     * Price of the first trade during the candlestick period (in dollars). Null if no trades occurred.
+     */
+    'open': string | null;
+    /**
+     * Lowest trade price during the candlestick period (in dollars). Null if no trades occurred.
+     */
+    'low': string | null;
+    /**
+     * Highest trade price during the candlestick period (in dollars). Null if no trades occurred.
+     */
+    'high': string | null;
+    /**
+     * Price of the last trade during the candlestick period (in dollars). Null if no trades occurred.
+     */
+    'close': string | null;
+    /**
+     * Volume-weighted average price during the candlestick period (in dollars). Null if no trades occurred.
+     */
+    'mean': string | null;
+    /**
+     * Close price from the previous candlestick period (in dollars). Null if this is the first candlestick or no prior trade exists.
+     */
+    'previous': string | null;
+}
+

package/models/price-distribution.ts

@@ -0,0 +1,83 @@
+/* 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 PriceDistribution {
+    /**
+     * First traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.
+     */
+    'open'?: number | null;
+    /**
+     * 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.
+     */
+    'open_dollars'?: string;
+    /**
+     * Lowest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.
+     */
+    'low'?: number | null;
+    /**
+     * 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.
+     */
+    'low_dollars'?: string;
+    /**
+     * Highest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.
+     */
+    'high'?: number | null;
+    /**
+     * 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.
+     */
+    'high_dollars'?: string;
+    /**
+     * Last traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.
+     */
+    'close'?: number | null;
+    /**
+     * 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.
+     */
+    'close_dollars'?: string;
+    /**
+     * Mean traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.
+     */
+    'mean'?: number | null;
+    /**
+     * 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.
+     */
+    'mean_dollars'?: string;
+    /**
+     * Last traded YES contract price on the market before the candlestick period (in cents). May be null if there were no trades before the period.
+     */
+    'previous'?: number | null;
+    /**
+     * 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.
+     */
+    'previous_dollars'?: string;
+    /**
+     * Minimum close price of any market during the candlestick period (in cents).
+     */
+    'min'?: number | null;
+    /**
+     * 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.
+     */
+    'min_dollars'?: string;
+    /**
+     * Maximum close price of any market during the candlestick period (in cents).
+     */
+    'max'?: number | null;
+    /**
+     * 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.
+     */
+    'max_dollars'?: string;
+}
+

package/models/price-range.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 PriceRange {
+    /**
+     * Starting price for this range in dollars
+     */
+    'start': string;
+    /**
+     * Ending price for this range in dollars
+     */
+    'end': string;
+    /**
+     * Price step/tick size for this range in dollars
+     */
+    'step': string;
+}
+