kalshi-typescript 3.6.0 → 3.7.0

package/models/quote.ts

@@ -0,0 +1,145 @@
+/* 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 Quote {
+    /**
+     * Unique identifier for the quote
+     */
+    'id': string;
+    /**
+     * ID of the RFQ this quote is responding to
+     */
+    'rfq_id': string;
+    /**
+     * Public communications ID of the quote creator
+     */
+    'creator_id': string;
+    /**
+     * Public communications ID of the RFQ creator
+     */
+    'rfq_creator_id': string;
+    /**
+     * The ticker of the market this quote is for
+     */
+    'market_ticker': string;
+    /**
+     * Number of contracts in the quote
+     */
+    '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;
+    /**
+     * Bid price for YES contracts, in cents
+     */
+    'yes_bid': number;
+    /**
+     * Bid price for NO contracts, in cents
+     */
+    '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.
+     */
+    'yes_bid_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_bid_dollars': string;
+    /**
+     * Timestamp when the quote was created
+     */
+    'created_ts': string;
+    /**
+     * Timestamp when the quote was last updated
+     */
+    'updated_ts': string;
+    /**
+     * Current status of the quote
+     */
+    'status': QuoteStatusEnum;
+    /**
+     * The side that was accepted (yes or no)
+     */
+    'accepted_side'?: QuoteAcceptedSideEnum;
+    /**
+     * Timestamp when the quote was accepted
+     */
+    'accepted_ts'?: string;
+    /**
+     * Timestamp when the quote was confirmed
+     */
+    'confirmed_ts'?: string;
+    /**
+     * Timestamp when the quote was executed
+     */
+    'executed_ts'?: string;
+    /**
+     * Timestamp when the quote was cancelled
+     */
+    'cancelled_ts'?: string;
+    /**
+     * Whether to rest the remainder of the quote after execution
+     */
+    'rest_remainder'?: boolean;
+    /**
+     * Reason for quote cancellation if cancelled
+     */
+    'cancellation_reason'?: string;
+    /**
+     * User ID of the quote creator (private field)
+     */
+    'creator_user_id'?: string;
+    /**
+     * User ID of the RFQ creator (private field)
+     */
+    'rfq_creator_user_id'?: string;
+    /**
+     * DEPRECATED: Total value requested in the RFQ in centi-cents. Use rfq_target_cost_dollars instead.
+     * @deprecated
+     */
+    'rfq_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.
+     */
+    'rfq_target_cost_dollars'?: string;
+    /**
+     * Order ID for the RFQ creator (private field)
+     */
+    'rfq_creator_order_id'?: string;
+    /**
+     * Order ID for the quote creator (private field)
+     */
+    'creator_order_id'?: string;
+}
+
+export const QuoteStatusEnum = {
+    Open: 'open',
+    Accepted: 'accepted',
+    Confirmed: 'confirmed',
+    Executed: 'executed',
+    Cancelled: 'cancelled'
+} as const;
+
+export type QuoteStatusEnum = typeof QuoteStatusEnum[keyof typeof QuoteStatusEnum];
+export const QuoteAcceptedSideEnum = {
+    Yes: 'yes',
+    No: 'no'
+} as const;
+
+export type QuoteAcceptedSideEnum = typeof QuoteAcceptedSideEnum[keyof typeof QuoteAcceptedSideEnum];
+
+

package/models/rfq.ts

@@ -0,0 +1,95 @@
+/* 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';
+
+export interface RFQ {
+    /**
+     * 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;
+    /**
+     * 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: Total value of 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;
+    /**
+     * 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 const RFQStatusEnum = {
+    Open: 'open',
+    Closed: 'closed'
+} as const;
+
+export type RFQStatusEnum = typeof RFQStatusEnum[keyof typeof RFQStatusEnum];
+
+

package/models/schedule.ts

@@ -0,0 +1,33 @@
+/* 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 { MaintenanceWindow } from './maintenance-window';
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/scope-list.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 ScopeList {
+    /**
+     * List of scopes
+     */
+    'scopes': Array<string>;
+}
+

package/models/self-trade-prevention-type.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 self-trade prevention type for orders
+ */
+
+export const SelfTradePreventionType = {
+    TakerAtCross: 'taker_at_cross',
+    Maker: 'maker'
+} as const;
+
+export type SelfTradePreventionType = typeof SelfTradePreventionType[keyof typeof SelfTradePreventionType];
+
+
+

package/models/series-fee-change.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.
+ */
+
+
+
+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 const SeriesFeeChangeFeeTypeEnum = {
+    Quadratic: 'quadratic',
+    QuadraticWithMakerFees: 'quadratic_with_maker_fees',
+    Flat: 'flat'
+} as const;
+
+export type SeriesFeeChangeFeeTypeEnum = typeof SeriesFeeChangeFeeTypeEnum[keyof typeof SeriesFeeChangeFeeTypeEnum];
+
+

package/models/series.ts

@@ -0,0 +1,87 @@
+/* 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 { SettlementSource } from './settlement-source';
+
+export interface 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.
+     */
+    'additional_prohibitions': Array<string>;
+    /**
+     * Total contracts traded across all events in this series.
+     */
+    '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;
+}
+
+export const SeriesFeeTypeEnum = {
+    Quadratic: 'quadratic',
+    QuadraticWithMakerFees: 'quadratic_with_maker_fees',
+    Flat: 'flat'
+} as const;
+
+export type SeriesFeeTypeEnum = typeof SeriesFeeTypeEnum[keyof typeof SeriesFeeTypeEnum];
+
+

package/models/settlement-source.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 SettlementSource {
+    /**
+     * Name of the settlement source
+     */
+    'name'?: string;
+    /**
+     * URL to the settlement source
+     */
+    'url'?: string;
+}
+

package/models/settlement.ts

@@ -0,0 +1,81 @@
+/* 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 Settlement {
+    /**
+     * The ticker symbol of the market that was settled.
+     */
+    'ticker': string;
+    /**
+     * The event ticker symbol of the market that was settled.
+     */
+    'event_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;
+    /**
+     * 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.
+     */
+    'yes_count_fp': string;
+    /**
+     * 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;
+    /**
+     * 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.
+     */
+    'no_count_fp': string;
+    /**
+     * 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;
+    /**
+     * 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.
+     */
+    'fee_cost': string;
+    /**
+     * Payout of a single yes contract in cents.
+     */
+    'value'?: number | null;
+}
+
+export const SettlementMarketResultEnum = {
+    Yes: 'yes',
+    No: 'no',
+    Scalar: 'scalar',
+    Void: 'void'
+} as const;
+
+export type SettlementMarketResultEnum = typeof SettlementMarketResultEnum[keyof typeof SettlementMarketResultEnum];
+
+

package/models/sport-filter-details.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 { 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/models/structured-target.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 StructuredTarget {
+    /**
+     * 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/models/subaccount-balance.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 SubaccountBalance {
+    /**
+     * Subaccount number (0 for primary, 1-32 for subaccounts).
+     */
+    'subaccount_number': 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.
+     */
+    'balance': string;
+    /**
+     * Unix timestamp of last balance update.
+     */
+    'updated_ts': number;
+}
+