kalshi-typescript 3.5.0 → 3.7.0

package/models/lookup-tickers-for-market-in-multivariate-event-collection-response.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 LookupTickersForMarketInMultivariateEventCollectionResponse {
+    /**
+     * Event ticker for the looked up market.
+     */
+    'event_ticker': string;
+    /**
+     * Market ticker for the looked up market.
+     */
+    'market_ticker': string;
+}
+

package/models/maintenance-window.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 MaintenanceWindow {
+    /**
+     * Start date and time of the maintenance window.
+     */
+    'start_datetime': string;
+    /**
+     * End date and time of the maintenance window.
+     */
+    'end_datetime': string;
+}
+

package/models/market-candlestick-historical.ts

@@ -0,0 +1,40 @@
+/* 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 { BidAskDistributionHistorical } from './bid-ask-distribution-historical';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PriceDistributionHistorical } from './price-distribution-historical';
+
+export interface MarketCandlestickHistorical {
+    /**
+     * Unix timestamp for the inclusive end of the candlestick period.
+     */
+    'end_period_ts': number;
+    'yes_bid': BidAskDistributionHistorical;
+    'yes_ask': BidAskDistributionHistorical;
+    'price': PriceDistributionHistorical;
+    /**
+     * 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.
+     */
+    'volume': string;
+    /**
+     * 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.
+     */
+    'open_interest': string;
+}
+

package/models/market-candlestick.ts

@@ -0,0 +1,48 @@
+/* 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 { BidAskDistribution } from './bid-ask-distribution';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PriceDistribution } from './price-distribution';
+
+export interface MarketCandlestick {
+    /**
+     * Unix timestamp for the inclusive end of the candlestick period.
+     */
+    'end_period_ts': number;
+    'yes_bid': BidAskDistribution;
+    'yes_ask': BidAskDistribution;
+    'price': PriceDistribution;
+    /**
+     * Number of contracts bought on the market during the candlestick period.
+     */
+    'volume': 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.
+     */
+    'volume_fp': string;
+    /**
+     * Number of contracts bought on the market by end of the candlestick period (end_period_ts).
+     */
+    'open_interest': 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.
+     */
+    'open_interest_fp': string;
+}
+

package/models/market-candlesticks-response.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MarketCandlestick } from './market-candlestick';
+
+export interface MarketCandlesticksResponse {
+    /**
+     * Market ticker string (e.g., \'INXD-24JAN01\').
+     */
+    'market_ticker': string;
+    /**
+     * Array of candlestick data points for the market. Includes an initial data point at the start timestamp when available.
+     */
+    'candlesticks': Array<MarketCandlestick>;
+}
+

package/models/market-metadata.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 MarketMetadata {
+    /**
+     * The ticker of the market.
+     */
+    'market_ticker': string;
+    /**
+     * A path to an image that represents this market.
+     */
+    'image_url': string;
+    /**
+     * The color code for the market.
+     */
+    'color_code': string;
+}
+

package/models/market-position.ts

@@ -0,0 +1,71 @@
+/* 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 MarketPosition {
+    /**
+     * Unique identifier for the market
+     */
+    'ticker': string;
+    /**
+     * Total spent on this market in cents
+     */
+    'total_traded': 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_traded_dollars': string;
+    /**
+     * Number of contracts bought in this market. Negative means NO contracts and positive means YES contracts
+     */
+    '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.
+     */
+    'position_fp': string;
+    /**
+     * Cost of the aggregate market position in cents
+     */
+    'market_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.
+     */
+    'market_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;
+    /**
+     * [DEPRECATED] Aggregate size of resting orders in contract units
+     */
+    'resting_orders_count': number;
+    /**
+     * 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;
+    /**
+     * Last time the position is updated
+     */
+    'last_updated_ts'?: string;
+}
+

package/models/market.ts

@@ -0,0 +1,310 @@
+/* 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 { MveSelectedLeg } from './mve-selected-leg';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PriceRange } from './price-range';
+
+export interface Market {
+    'ticker': string;
+    'event_ticker': string;
+    /**
+     * Identifies the type of market
+     */
+    'market_type': MarketMarketTypeEnum;
+    /**
+     * @deprecated
+     */
+    'title': string;
+    /**
+     * @deprecated
+     */
+    'subtitle': string;
+    /**
+     * Shortened title for the yes side of this market
+     */
+    'yes_sub_title': string;
+    /**
+     * Shortened title for the no side of this market
+     */
+    'no_sub_title': string;
+    'created_time': string;
+    /**
+     * Time of the last non-trading metadata update.
+     */
+    'updated_time': string;
+    'open_time': string;
+    'close_time': string;
+    /**
+     * Time when this market is expected to expire
+     */
+    'expected_expiration_time'?: string | null;
+    /**
+     * @deprecated
+     */
+    'expiration_time': string;
+    /**
+     * Latest possible time for this market to expire
+     */
+    'latest_expiration_time': string;
+    /**
+     * The amount of time after determination that the market settles
+     */
+    'settlement_timer_seconds': number;
+    /**
+     * The current status of the market in its lifecycle.
+     */
+    'status': MarketStatusEnum;
+    /**
+     * DEPRECATED: Use price_level_structure and price_ranges instead.
+     * @deprecated
+     */
+    'response_price_units': MarketResponsePriceUnitsEnum;
+    /**
+     * DEPRECATED: Use yes_bid_dollars instead.
+     * @deprecated
+     */
+    'yes_bid': 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_bid_dollars': string;
+    /**
+     * DEPRECATED: Use yes_ask_dollars instead.
+     * @deprecated
+     */
+    'yes_ask': 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_ask_dollars': string;
+    /**
+     * DEPRECATED: Use no_bid_dollars instead.
+     * @deprecated
+     */
+    'no_bid': 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.
+     */
+    'no_bid_dollars': string;
+    /**
+     * DEPRECATED: Use no_ask_dollars instead.
+     * @deprecated
+     */
+    'no_ask': 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.
+     */
+    'no_ask_dollars': string;
+    /**
+     * DEPRECATED: Use last_price_dollars instead.
+     * @deprecated
+     */
+    'last_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.
+     */
+    'last_price_dollars': string;
+    'volume': 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.
+     */
+    'volume_fp': string;
+    'volume_24h': 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.
+     */
+    'volume_24h_fp': string;
+    'result': MarketResultEnum;
+    'can_close_early': boolean;
+    'fractional_trading_enabled': boolean;
+    /**
+     * Number of contracts bought on this market disconsidering netting
+     */
+    'open_interest': 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.
+     */
+    'open_interest_fp': string;
+    /**
+     * DEPRECATED: Use notional_value_dollars instead.
+     * @deprecated
+     */
+    'notional_value': 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.
+     */
+    'notional_value_dollars': string;
+    /**
+     * DEPRECATED: Use previous_yes_bid_dollars instead.
+     * @deprecated
+     */
+    'previous_yes_bid': 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.
+     */
+    'previous_yes_bid_dollars': string;
+    /**
+     * DEPRECATED: Use previous_yes_ask_dollars instead.
+     * @deprecated
+     */
+    'previous_yes_ask': 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.
+     */
+    'previous_yes_ask_dollars': string;
+    /**
+     * DEPRECATED: Use previous_price_dollars instead.
+     * @deprecated
+     */
+    'previous_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.
+     */
+    'previous_price_dollars': string;
+    /**
+     * DEPRECATED: This field is deprecated and will always return 0.
+     * @deprecated
+     */
+    'liquidity': 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.
+     */
+    'liquidity_dollars': string;
+    /**
+     * The settlement value of the YES/LONG side of the contract in cents. Only filled after determination
+     */
+    'settlement_value'?: 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.
+     */
+    'settlement_value_dollars'?: string;
+    /**
+     * Timestamp when the market was settled. Only filled for settled markets
+     */
+    'settlement_ts'?: string | null;
+    /**
+     * The value that was considered for the settlement
+     */
+    'expiration_value': string;
+    /**
+     * Time when this market\'s fee waiver expires
+     */
+    'fee_waiver_expiration_time'?: string | null;
+    /**
+     * The condition under which the market can close early
+     */
+    'early_close_condition'?: string | null;
+    /**
+     * DEPRECATED: Use price_level_structure and price_ranges instead.
+     * @deprecated
+     */
+    'tick_size': number;
+    /**
+     * Strike type defines how the market strike is defined and evaluated
+     */
+    'strike_type'?: MarketStrikeTypeEnum;
+    /**
+     * Minimum expiration value that leads to a YES settlement
+     */
+    'floor_strike'?: number | null;
+    /**
+     * Maximum expiration value that leads to a YES settlement
+     */
+    'cap_strike'?: number | null;
+    /**
+     * Mapping from expiration values to settlement values
+     */
+    'functional_strike'?: string | null;
+    /**
+     * Expiration value for each target that leads to a YES settlement
+     */
+    'custom_strike'?: object | null;
+    /**
+     * A plain language description of the most important market terms
+     */
+    'rules_primary': string;
+    /**
+     * A plain language description of secondary market terms
+     */
+    'rules_secondary': string;
+    /**
+     * The ticker of the multivariate event collection
+     */
+    'mve_collection_ticker'?: string;
+    'mve_selected_legs'?: Array<MveSelectedLeg>;
+    'primary_participant_key'?: string | null;
+    /**
+     * Price level structure for this market, defining price ranges and tick sizes
+     */
+    'price_level_structure': string;
+    /**
+     * Valid price ranges for orders on this market
+     */
+    'price_ranges': Array<PriceRange>;
+    /**
+     * If true, the market may be removed after determination if there is no activity on it
+     */
+    'is_provisional'?: boolean;
+}
+
+export const MarketMarketTypeEnum = {
+    Binary: 'binary',
+    Scalar: 'scalar'
+} as const;
+
+export type MarketMarketTypeEnum = typeof MarketMarketTypeEnum[keyof typeof MarketMarketTypeEnum];
+export const MarketStatusEnum = {
+    Initialized: 'initialized',
+    Inactive: 'inactive',
+    Active: 'active',
+    Closed: 'closed',
+    Determined: 'determined',
+    Disputed: 'disputed',
+    Amended: 'amended',
+    Finalized: 'finalized'
+} as const;
+
+export type MarketStatusEnum = typeof MarketStatusEnum[keyof typeof MarketStatusEnum];
+export const MarketResponsePriceUnitsEnum = {
+    UsdCent: 'usd_cent'
+} as const;
+
+export type MarketResponsePriceUnitsEnum = typeof MarketResponsePriceUnitsEnum[keyof typeof MarketResponsePriceUnitsEnum];
+export const MarketResultEnum = {
+    Yes: 'yes',
+    No: 'no',
+    Scalar: 'scalar',
+    Empty: ''
+} as const;
+
+export type MarketResultEnum = typeof MarketResultEnum[keyof typeof MarketResultEnum];
+export const MarketStrikeTypeEnum = {
+    Greater: 'greater',
+    GreaterOrEqual: 'greater_or_equal',
+    Less: 'less',
+    LessOrEqual: 'less_or_equal',
+    Between: 'between',
+    Functional: 'functional',
+    Custom: 'custom',
+    Structured: 'structured'
+} as const;
+
+export type MarketStrikeTypeEnum = typeof MarketStrikeTypeEnum[keyof typeof MarketStrikeTypeEnum];
+
+

package/models/milestone.ts

@@ -0,0 +1,67 @@
+/* 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 Milestone {
+    /**
+     * Unique identifier for the milestone.
+     */
+    'id': string;
+    /**
+     * Category of the milestone.
+     */
+    'category': string;
+    /**
+     * Type of the milestone.
+     */
+    'type': string;
+    /**
+     * Start date of the milestone.
+     */
+    'start_date': string;
+    /**
+     * End date of the milestone, if any.
+     */
+    'end_date'?: string | null;
+    /**
+     * List of event tickers related to this milestone.
+     */
+    'related_event_tickers': Array<string>;
+    /**
+     * Title of the milestone.
+     */
+    'title': string;
+    /**
+     * Notification message for the milestone.
+     */
+    'notification_message': string;
+    /**
+     * Source id of milestone if available.
+     */
+    'source_id'?: string | null;
+    /**
+     * Additional details about the milestone.
+     */
+    'details': { [key: string]: any; };
+    /**
+     * List of event tickers directly related to the outcome of this milestone.
+     */
+    'primary_event_tickers': Array<string>;
+    /**
+     * Last time this structured target was updated.
+     */
+    'last_updated_ts': string;
+}
+