kalshi-typescript 3.5.0 → 3.7.0

package/models/amend-order-response.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Order } from './order';
+
+export interface AmendOrderResponse {
+    'old_order': Order;
+    'order': Order;
+}
+

package/models/announcement.ts

@@ -0,0 +1,50 @@
+/* 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 Announcement {
+    /**
+     * The type of the announcement.
+     */
+    'type': AnnouncementTypeEnum;
+    /**
+     * The message contained within the announcement.
+     */
+    'message': string;
+    /**
+     * The time the announcement was delivered.
+     */
+    'delivery_time': string;
+    /**
+     * The current status of this announcement.
+     */
+    'status': AnnouncementStatusEnum;
+}
+
+export const AnnouncementTypeEnum = {
+    Info: 'info',
+    Warning: 'warning',
+    Error: 'error'
+} as const;
+
+export type AnnouncementTypeEnum = typeof AnnouncementTypeEnum[keyof typeof AnnouncementTypeEnum];
+export const AnnouncementStatusEnum = {
+    Active: 'active',
+    Inactive: 'inactive'
+} as const;
+
+export type AnnouncementStatusEnum = typeof AnnouncementStatusEnum[keyof typeof AnnouncementStatusEnum];
+
+

package/models/api-key.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 ApiKey {
+    /**
+     * Unique identifier for the API key
+     */
+    'api_key_id': string;
+    /**
+     * User-provided name for the API key
+     */
+    'name': string;
+    /**
+     * List of scopes granted to this API key. Valid values are \'read\' and \'write\'.
+     */
+    'scopes': Array<string>;
+}
+

package/{dist/models/transfer-between-subaccounts-request.d.ts → models/apply-subaccount-transfer-request.ts}

@@ -1,15 +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.4.0
- *
+ * 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 TransferBetweenSubaccountsRequest {
+
+
+
+export interface ApplySubaccountTransferRequest {
+    /**
+     * Unique client-provided transfer ID for idempotency.
+     */
+    'client_transfer_id': string;
     /**
      * Source subaccount number (0 for primary, 1-32 for numbered subaccounts).
      */
@@ -23,3 +32,4 @@ export interface TransferBetweenSubaccountsRequest {
      */
     'amount_cents': number;
 }
+

package/models/associated-event.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 AssociatedEvent {
+    /**
+     * The event ticker.
+     */
+    'ticker': string;
+    /**
+     * Whether only the \'yes\' side can be used for this event.
+     */
+    'is_yes_only': boolean;
+    /**
+     * Maximum number of markets from this event (inclusive). Null means no limit.
+     */
+    'size_max'?: number | null;
+    /**
+     * Minimum number of markets from this event (inclusive). Null means no limit.
+     */
+    'size_min'?: number | null;
+    /**
+     * List of active quoters for this event.
+     */
+    'active_quoters': Array<string>;
+}
+

package/models/batch-cancel-orders-individual-response.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ErrorResponse } from './error-response';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Order } from './order';
+
+export interface BatchCancelOrdersIndividualResponse {
+    /**
+     * The order ID to identify which order had an error during batch cancellation
+     */
+    'order_id': string;
+    'order'?: Order | null;
+    /**
+     * The number of contracts that were successfully canceled from this order
+     */
+    'reduced_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.
+     */
+    'reduced_by_fp': string;
+    'error'?: ErrorResponse | null;
+}
+

package/models/batch-cancel-orders-request-order.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 BatchCancelOrdersRequestOrder {
+    /**
+     * Order ID to cancel
+     */
+    'order_id': string;
+    /**
+     * Optional subaccount number to use for this cancellation (0 for primary, 1-32 for subaccounts)
+     */
+    'subaccount'?: number;
+}
+

package/models/batch-cancel-orders-request.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { BatchCancelOrdersRequestOrder } from './batch-cancel-orders-request-order';
+
+export interface BatchCancelOrdersRequest {
+    /**
+     * An array of order IDs to cancel
+     * @deprecated
+     */
+    'ids'?: Array<string>;
+    /**
+     * An array of orders to cancel, each optionally specifying a subaccount
+     */
+    'orders'?: Array<BatchCancelOrdersRequestOrder>;
+}
+

package/models/batch-cancel-orders-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 { BatchCancelOrdersIndividualResponse } from './batch-cancel-orders-individual-response';
+
+export interface BatchCancelOrdersResponse {
+    'orders': Array<BatchCancelOrdersIndividualResponse>;
+}
+

package/models/batch-create-orders-individual-response.ts

@@ -0,0 +1,28 @@
+/* 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 { ErrorResponse } from './error-response';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Order } from './order';
+
+export interface BatchCreateOrdersIndividualResponse {
+    'client_order_id'?: string | null;
+    'order'?: Order | null;
+    'error'?: ErrorResponse | null;
+}
+

package/models/batch-create-orders-request.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 { CreateOrderRequest } from './create-order-request';
+
+export interface BatchCreateOrdersRequest {
+    'orders': Array<CreateOrderRequest>;
+}
+

package/models/batch-create-orders-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 { BatchCreateOrdersIndividualResponse } from './batch-create-orders-individual-response';
+
+export interface BatchCreateOrdersResponse {
+    'orders': Array<BatchCreateOrdersIndividualResponse>;
+}
+

package/models/batch-get-market-candlesticks-response.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MarketCandlesticksResponse } from './market-candlesticks-response';
+
+export interface BatchGetMarketCandlesticksResponse {
+    /**
+     * Array of market candlestick data, one entry per requested market.
+     */
+    'markets': Array<MarketCandlesticksResponse>;
+}
+

package/models/bid-ask-distribution-historical.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 BidAskDistributionHistorical {
+    /**
+     * 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': 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.
+     */
+    'low': 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.
+     */
+    'high': 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.
+     */
+    'close': string;
+}
+

package/models/bid-ask-distribution.ts

@@ -0,0 +1,51 @@
+/* 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 BidAskDistribution {
+    /**
+     * Offer price on the market at the start of the candlestick period (in cents).
+     */
+    'open': 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.
+     */
+    'open_dollars': string;
+    /**
+     * Lowest offer price on the market during the candlestick period (in cents).
+     */
+    'low': 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.
+     */
+    'low_dollars': string;
+    /**
+     * Highest offer price on the market during the candlestick period (in cents).
+     */
+    'high': 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.
+     */
+    'high_dollars': string;
+    /**
+     * Offer price on the market at the end of the candlestick period (in cents).
+     */
+    'close': 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.
+     */
+    'close_dollars': string;
+}
+

package/models/cancel-order-response.ts

@@ -0,0 +1,28 @@
+/* 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 CancelOrderResponse {
+    'order': Order;
+    'reduced_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.
+     */
+    'reduced_by_fp': string;
+}
+

package/models/create-api-key-request.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 CreateApiKeyRequest {
+    /**
+     * Name for the API key. This helps identify the key\'s purpose
+     */
+    'name': string;
+    /**
+     * RSA public key in PEM format. This will be used to verify signatures on API requests
+     */
+    'public_key': string;
+    /**
+     * List of scopes to grant to the API key. Valid values are \'read\' and \'write\'. If \'write\' is included, \'read\' must also be included. Defaults to full access ([\'read\', \'write\']) if not provided.
+     */
+    'scopes'?: Array<string>;
+}
+

package/models/create-api-key-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 CreateApiKeyResponse {
+    /**
+     * Unique identifier for the newly created API key
+     */
+    'api_key_id': string;
+}
+

package/models/create-market-in-multivariate-event-collection-request.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 { TickerPair } from './ticker-pair';
+
+export interface CreateMarketInMultivariateEventCollectionRequest {
+    /**
+     * List of selected markets that act as parameters to determine which market is created.
+     */
+    'selected_markets': Array<TickerPair>;
+    /**
+     * Whether to include the market payload in the response.
+     */
+    'with_market_payload'?: boolean;
+}
+

package/models/create-market-in-multivariate-event-collection-response.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Market } from './market';
+
+export interface CreateMarketInMultivariateEventCollectionResponse {
+    /**
+     * Event ticker for the created market.
+     */
+    'event_ticker': string;
+    /**
+     * Market ticker for the created market.
+     */
+    'market_ticker': string;
+    'market'?: Market;
+}
+

package/models/create-order-group-request.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 CreateOrderGroupRequest {
+    /**
+     * Optional subaccount number to use for this order group (0 for primary, 1-32 for subaccounts)
+     */
+    'subaccount'?: number;
+    /**
+     * Specifies the maximum number of contracts that can be matched within this group over a rolling 15-second window. Whole contracts only. Provide contracts_limit or contracts_limit_fp; if both provided they must match.
+     */
+    '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;
+}
+