kalshi-typescript 3.6.0 → 3.7.0

package/models/fill.ts

@@ -0,0 +1,113 @@
+/* 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 Fill {
+    /**
+     * Unique identifier for this fill
+     */
+    'fill_id': string;
+    /**
+     * Unique identifier for this fill (legacy field name, same as fill_id)
+     */
+    'trade_id': string;
+    /**
+     * Unique identifier for the order that resulted in this fill
+     */
+    'order_id': string;
+    /**
+     * Client-provided identifier for the order that resulted in this fill
+     */
+    'client_order_id'?: string;
+    /**
+     * Unique identifier for the market
+     */
+    'ticker': string;
+    /**
+     * Unique identifier for the market (legacy field name, same as ticker)
+     */
+    'market_ticker': string;
+    /**
+     * Specifies if this is a \'yes\' or \'no\' fill
+     */
+    'side': FillSideEnum;
+    /**
+     * Specifies if this is a buy or sell order
+     */
+    'action': FillActionEnum;
+    /**
+     * Number of contracts bought or sold in this 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.
+     */
+    'count_fp': string;
+    /**
+     * Fill price (deprecated - use yes_price or no_price)
+     */
+    'price': number;
+    /**
+     * Fill price for the yes side in cents
+     */
+    'yes_price': number;
+    /**
+     * Fill price for the no side in cents
+     */
+    'no_price': number;
+    /**
+     * Fill price for the yes side in fixed point dollars
+     */
+    'yes_price_fixed': string;
+    /**
+     * Fill price for the no side in fixed point dollars
+     */
+    'no_price_fixed': string;
+    /**
+     * If true, this fill was a taker (removed liquidity from the order book)
+     */
+    'is_taker': boolean;
+    /**
+     * Timestamp when this fill was executed
+     */
+    'created_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;
+    /**
+     * Subaccount number (0 for primary, 1-32 for subaccounts). Present for direct users.
+     */
+    'subaccount_number'?: number | null;
+    /**
+     * Unix timestamp when this fill was executed (legacy field name)
+     */
+    'ts'?: number;
+}
+
+export const FillSideEnum = {
+    Yes: 'yes',
+    No: 'no'
+} as const;
+
+export type FillSideEnum = typeof FillSideEnum[keyof typeof FillSideEnum];
+export const FillActionEnum = {
+    Buy: 'buy',
+    Sell: 'sell'
+} as const;
+
+export type FillActionEnum = typeof FillActionEnum[keyof typeof FillActionEnum];
+
+

package/models/forecast-percentiles-point.ts

@@ -0,0 +1,38 @@
+/* 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 { PercentilePoint } from './percentile-point';
+
+export interface ForecastPercentilesPoint {
+    /**
+     * The event ticker this forecast is for.
+     */
+    'event_ticker': string;
+    /**
+     * Unix timestamp for the inclusive end of the forecast period.
+     */
+    'end_period_ts': number;
+    /**
+     * Length of the forecast period in minutes.
+     */
+    'period_interval': number;
+    /**
+     * Array of forecast values at different percentiles.
+     */
+    'percentile_points': Array<PercentilePoint>;
+}
+

package/models/generate-api-key-request.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 GenerateApiKeyRequest {
+    /**
+     * Name for the API key. This helps identify the key\'s purpose
+     */
+    'name': 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/generate-api-key-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 GenerateApiKeyResponse {
+    /**
+     * Unique identifier for the newly generated API key
+     */
+    'api_key_id': string;
+    /**
+     * RSA private key in PEM format. This must be stored securely and cannot be retrieved again after this response
+     */
+    'private_key': string;
+}
+

package/{dist/esm/models/account-limit.d.ts → models/get-account-api-limits-response.ts}

@@ -1,25 +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.6.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 AccountLimit {
+
+
+
+export interface GetAccountApiLimitsResponse {
     /**
-     * User\'s account API tier
+     * User\'s API usage tier
      */
-    'tier': string;
+    'usage_tier': string;
     /**
-     * User\'s account API read limit (qps)
+     * Maximum read requests per second
      */
     'read_limit': number;
     /**
-     * User\'s account API write limit (qps)
+     * Maximum write requests per second
      */
     'write_limit': number;
 }
+

package/models/get-api-keys-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 { ApiKey } from './api-key';
+
+export interface GetApiKeysResponse {
+    /**
+     * List of all API keys associated with the user
+     */
+    'api_keys': Array<ApiKey>;
+}
+

package/models/get-balance-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.
+ */
+
+
+
+export interface GetBalanceResponse {
+    /**
+     * Member\'s available balance in cents. This represents the amount available for trading.
+     */
+    'balance': number;
+    /**
+     * Member\'s portfolio value in cents. This is the current value of all positions held.
+     */
+    'portfolio_value': number;
+    /**
+     * Unix timestamp of the last update to the balance.
+     */
+    'updated_ts': number;
+}
+

package/models/get-communications-idresponse.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 GetCommunicationsIDResponse {
+    /**
+     * A public communications ID which is used to identify the user
+     */
+    'communications_id': string;
+}
+

package/{dist/models/get-events-candlesticks-response-events-inner.d.ts → models/get-event-candlesticks-response.ts}

@@ -1,20 +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: 2.0.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.
  */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
 import type { MarketCandlestick } from './market-candlestick';
-export interface GetEventsCandlesticksResponseEventsInner {
-    /**
-     * The event ticker
-     */
-    'event_ticker': string;
+
+export interface GetEventCandlesticksResponse {
     /**
      * Array of market tickers in the event.
      */
@@ -28,3 +31,4 @@ export interface GetEventsCandlesticksResponseEventsInner {
      */
     'adjusted_end_ts': number;
 }
+

package/models/get-event-forecast-percentiles-history-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 { ForecastPercentilesPoint } from './forecast-percentiles-point';
+
+export interface GetEventForecastPercentilesHistoryResponse {
+    /**
+     * Array of forecast percentile data points over time.
+     */
+    'forecast_history': Array<ForecastPercentilesPoint>;
+}
+

package/models/get-event-metadata-response.ts

@@ -0,0 +1,49 @@
+/* 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 { MarketMetadata } from './market-metadata';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SettlementSource } from './settlement-source';
+
+export interface GetEventMetadataResponse {
+    /**
+     * A path to an image that represents this event.
+     */
+    'image_url': string;
+    /**
+     * A path to an image that represents the image of the featured market.
+     */
+    'featured_image_url'?: string;
+    /**
+     * Metadata for the markets in this event.
+     */
+    'market_details': Array<MarketMetadata>;
+    /**
+     * A list of settlement sources for this event.
+     */
+    'settlement_sources': Array<SettlementSource>;
+    /**
+     * Event competition.
+     */
+    'competition'?: string | null;
+    /**
+     * Event scope, based on the competition.
+     */
+    'competition_scope'?: string | null;
+}
+

package/models/get-event-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 { EventData } from './event-data';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Market } from './market';
+
+export interface GetEventResponse {
+    'event': EventData;
+    /**
+     * Data for the markets in this event. This field is deprecated in favour of the \"markets\" field inside the event. Which will be filled with the same value if you use the query parameter \"with_nested_markets=true\".
+     */
+    'markets': Array<Market>;
+}
+

package/models/get-events-response.ts

@@ -0,0 +1,37 @@
+/* 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 { EventData } from './event-data';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Milestone } from './milestone';
+
+export interface GetEventsResponse {
+    /**
+     * Array of events matching the query criteria.
+     */
+    'events': Array<EventData>;
+    /**
+     * Array of milestones related to the events.
+     */
+    'milestones'?: Array<Milestone>;
+    /**
+     * Pagination cursor for the next page. Empty if there are no more results.
+     */
+    'cursor': string;
+}
+

package/models/get-exchange-announcements-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 { Announcement } from './announcement';
+
+export interface GetExchangeAnnouncementsResponse {
+    /**
+     * A list of exchange-wide announcements.
+     */
+    'announcements': Array<Announcement>;
+}
+

package/models/get-exchange-schedule-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 { Schedule } from './schedule';
+
+export interface GetExchangeScheduleResponse {
+    'schedule': Schedule;
+}
+

package/models/get-fills-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 { Fill } from './fill';
+
+export interface GetFillsResponse {
+    'fills': Array<Fill>;
+    'cursor': string;
+}
+

package/models/get-filters-by-sports-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 { SportFilterDetails } from './sport-filter-details';
+
+export interface GetFiltersBySportsResponse {
+    /**
+     * Mapping of sports to their filter details
+     */
+    'filters_by_sports': { [key: string]: SportFilterDetails; };
+    /**
+     * Ordered list of sports for display
+     */
+    'sport_ordering': Array<string>;
+}
+

package/models/get-historical-cutoff-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.
+ */
+
+
+
+export interface GetHistoricalCutoffResponse {
+    /**
+     * Cutoff based on **market settlement time**. Markets and their candlesticks that settled before this timestamp must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`. 
+     */
+    'market_settled_ts': string;
+    /**
+     * Cutoff based on **trade fill time**. Fills that occurred before this timestamp must be accessed via `GET /historical/fills`. 
+     */
+    'trades_created_ts': string;
+    /**
+     * Cutoff based on **order cancellation or execution time**. Orders canceled or fully executed before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`. 
+     */
+    'orders_updated_ts': string;
+}
+

package/models/get-incentive-programs-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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { IncentiveProgram } from './incentive-program';
+
+export interface GetIncentiveProgramsResponse {
+    'incentive_programs': Array<IncentiveProgram>;
+    /**
+     * Cursor for pagination to get the next page of results
+     */
+    'next_cursor'?: string;
+}
+