kalshi-typescript 2.1.2 → 3.0.0

package/docs/TickerPair.md

@@ -0,0 +1,24 @@
+# TickerPair
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market_ticker** | **string** | Market ticker identifier. | [default to undefined]
+**event_ticker** | **string** | Event ticker identifier. | [default to undefined]
+**side** | **string** | Side of the market (yes or no). | [default to undefined]
+
+## Example
+
+```typescript
+import { TickerPair } from 'kalshi-typescript';
+
+const instance: TickerPair = {
+    market_ticker,
+    event_ticker,
+    side,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Trade.md

@@ -5,12 +5,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**trade_id** | **string** |  | [optional] [default to undefined]
-**ticker** | **string** |  | [optional] [default to undefined]
-**price** | **number** |  | [optional] [default to undefined]
-**count** | **number** |  | [optional] [default to undefined]
-**taker_side** | **string** |  | [optional] [default to undefined]
-**created_time** | **string** |  | [optional] [default to undefined]
+**trade_id** | **string** | Unique identifier for this trade | [default to undefined]
+**ticker** | **string** | Unique identifier for the market | [default to undefined]
+**price** | **number** | Trade price (deprecated - use yes_price or no_price) | [default to undefined]
+**count** | **number** | Number of contracts bought or sold in this trade | [default to undefined]
+**yes_price** | **number** | Yes price for this trade in cents | [default to undefined]
+**no_price** | **number** | No price for this trade in cents | [default to undefined]
+**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
+**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
+**taker_side** | **string** | Side for the taker of this trade | [default to undefined]
+**created_time** | **string** | Timestamp when this trade was executed | [optional] [default to undefined]
 
 ## Example
 
@@ -22,6 +26,10 @@ const instance: Trade = {
     ticker,
     price,
     count,
+    yes_price,
+    no_price,
+    yes_price_dollars,
+    no_price_dollars,
     taker_side,
     created_time,
 };

package/docs/WeeklySchedule.md

@@ -0,0 +1,36 @@
+# WeeklySchedule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_time** | **string** | Start date and time for when this weekly schedule is effective. | [default to undefined]
+**end_time** | **string** | End date and time for when this weekly schedule is no longer effective. | [default to undefined]
+**monday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Monday. May contain multiple sessions. | [default to undefined]
+**tuesday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Tuesday. May contain multiple sessions. | [default to undefined]
+**wednesday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Wednesday. May contain multiple sessions. | [default to undefined]
+**thursday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Thursday. May contain multiple sessions. | [default to undefined]
+**friday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Friday. May contain multiple sessions. | [default to undefined]
+**saturday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Saturday. May contain multiple sessions. | [default to undefined]
+**sunday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Sunday. May contain multiple sessions. | [default to undefined]
+
+## Example
+
+```typescript
+import { WeeklySchedule } from 'kalshi-typescript';
+
+const instance: WeeklySchedule = {
+    start_time,
+    end_time,
+    monday,
+    tuesday,
+    wednesday,
+    thursday,
+    friday,
+    saturday,
+    sunday,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/models/accept-quote-request.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -15,6 +15,17 @@
 
 
 export interface AcceptQuoteRequest {
-    'size'?: number;
+    /**
+     * The side of the quote to accept (yes or no)
+     */
+    'accepted_side': AcceptQuoteRequestAcceptedSideEnum;
 }
 
+export const AcceptQuoteRequestAcceptedSideEnum = {
+    True: 'true',
+    False: 'false'
+} as const;
+
+export type AcceptQuoteRequestAcceptedSideEnum = typeof AcceptQuoteRequestAcceptedSideEnum[keyof typeof AcceptQuoteRequestAcceptedSideEnum];
+
+

package/models/amend-order-request.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -24,20 +24,37 @@ export interface AmendOrderRequest {
      */
     'side': AmendOrderRequestSideEnum;
     /**
-     * Buy or sell action
+     * Action of the order
      */
     'action': AmendOrderRequestActionEnum;
-    'yes_price'?: number;
-    'no_price'?: number;
-    'count'?: number;
     /**
-     * Current client order ID
+     * The original client-specified order ID to be amended
      */
     'client_order_id': string;
     /**
-     * New client order ID after amendment
+     * The new client-specified order ID after amendment
      */
     'updated_client_order_id': string;
+    /**
+     * Updated yes price for the order in cents
+     */
+    'yes_price'?: number;
+    /**
+     * Updated no price for the order in cents
+     */
+    'no_price'?: number;
+    /**
+     * US dollar amount as a fixed-point decimal string with exactly 4 decimal places
+     */
+    'yes_price_dollars'?: string;
+    /**
+     * US dollar amount as a fixed-point decimal string with exactly 4 decimal places
+     */
+    'no_price_dollars'?: string;
+    /**
+     * Updated quantity for the order
+     */
+    'count'?: number;
 }
 
 export const AmendOrderRequestSideEnum = {

package/models/amend-order-response.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -18,6 +18,7 @@
 import type { Order } from './order';
 
 export interface AmendOrderResponse {
-    'order'?: Order;
+    'old_order': Order;
+    'order': Order;
 }
 

package/models/announcement.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -15,18 +15,24 @@
 
 
 export interface Announcement {
-    'delivery_time'?: string;
-    'message'?: string;
-    'status'?: AnnouncementStatusEnum;
-    'type'?: AnnouncementTypeEnum;
+    /**
+     * 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 AnnouncementStatusEnum = {
-    Active: 'active',
-    Inactive: 'inactive'
-} as const;
-
-export type AnnouncementStatusEnum = typeof AnnouncementStatusEnum[keyof typeof AnnouncementStatusEnum];
 export const AnnouncementTypeEnum = {
     Info: 'info',
     Warning: 'warning',
@@ -34,5 +40,11 @@ export const AnnouncementTypeEnum = {
 } 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

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -23,9 +23,5 @@ export interface ApiKey {
      * User-provided name for the API key
      */
     'name': string;
-    /**
-     * Timestamp when the API key was created
-     */
-    'created_ts'?: string;
 }
 

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.0.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,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.0.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;
+    'error'?: ErrorResponse | null;
+}
+

package/models/batch-cancel-orders-request.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -15,6 +15,9 @@
 
 
 export interface BatchCancelOrdersRequest {
-    'order_ids': Array<string>;
+    /**
+     * An array of order IDs to cancel
+     */
+    'ids': Array<string>;
 }
 

package/models/batch-cancel-orders-response-responses-inner.ts

@@ -22,4 +22,3 @@ export interface BatchCancelOrdersResponseResponsesInner {
     'reduced_by'?: number;
     'error'?: ErrorResponse;
 }
-

package/models/batch-cancel-orders-response.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -15,9 +15,9 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { BatchCancelOrdersResponseResponsesInner } from './batch-cancel-orders-response-responses-inner';
+import type { BatchCancelOrdersIndividualResponse } from './batch-cancel-orders-individual-response';
 
 export interface BatchCancelOrdersResponse {
-    'responses'?: Array<BatchCancelOrdersResponseResponsesInner>;
+    '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.0.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

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/models/batch-create-orders-response-responses-inner.ts

@@ -24,4 +24,3 @@ export interface BatchCreateOrdersResponseResponsesInner {
     'order'?: Order;
     'error'?: ErrorResponse;
 }
-

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

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -15,9 +15,9 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { BatchCreateOrdersResponseResponsesInner } from './batch-create-orders-response-responses-inner';
+import type { BatchCreateOrdersIndividualResponse } from './batch-create-orders-individual-response';
 
 export interface BatchCreateOrdersResponse {
-    'responses'?: Array<BatchCreateOrdersResponseResponsesInner>;
+    '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.0.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.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.0.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 exactly 4 decimal places
+     */
+    '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 exactly 4 decimal places
+     */
+    '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 exactly 4 decimal places
+     */
+    '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 exactly 4 decimal places
+     */
+    'close_dollars': string;
+}
+

package/models/cancel-order-response.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -18,7 +18,7 @@
 import type { Order } from './order';
 
 export interface CancelOrderResponse {
-    'order'?: Order;
-    'reduced_by'?: number;
+    'order': Order;
+    'reduced_by': number;
 }
 

package/models/candlestick.ts

@@ -23,4 +23,3 @@ export interface Candlestick {
     'close'?: number;
     'volume'?: number;
 }
-