kalshi-typescript 2.1.2 → 3.0.0

package/docs/CreateRFQRequest.md

@@ -5,10 +5,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ticker** | **string** |  | [default to undefined]
-**side** | **string** |  | [default to undefined]
-**size** | **number** |  | [default to undefined]
-**expires_in_seconds** | **number** |  | [optional] [default to undefined]
+**market_ticker** | **string** | The ticker of the market for which to create an RFQ | [default to undefined]
+**contracts** | **number** | The number of contracts for the RFQ | [optional] [default to undefined]
+**target_cost_centi_cents** | **number** | The target cost for the RFQ in centi-cents | [optional] [default to undefined]
+**rest_remainder** | **boolean** | Whether to rest the remainder of the RFQ after execution | [default to undefined]
+**replace_existing** | **boolean** | Whether to delete existing RFQs as part of this RFQ\'s creation | [optional] [default to false]
+**subtrader_id** | **string** | The subtrader to create the RFQ for (FCM members only) | [optional] [default to undefined]
 
 ## Example
 
@@ -16,10 +18,12 @@ Name | Type | Description | Notes
 import { CreateRFQRequest } from 'kalshi-typescript';
 
 const instance: CreateRFQRequest = {
-    ticker,
-    side,
-    size,
-    expires_in_seconds,
+    market_ticker,
+    contracts,
+    target_cost_centi_cents,
+    rest_remainder,
+    replace_existing,
+    subtrader_id,
 };
 ```
 

package/docs/CreateRFQResponse.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**rfq** | [**RFQ**](RFQ.md) |  | [optional] [default to undefined]
+**id** | **string** | The ID of the newly created RFQ | [default to undefined]
 
 ## Example
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 import { CreateRFQResponse } from 'kalshi-typescript';
 
 const instance: CreateRFQResponse = {
-    rfq,
+    id,
 };
 ```
 

package/docs/DailySchedule.md

@@ -5,8 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**open_time** | **string** |  | [optional] [default to undefined]
-**close_time** | **string** |  | [optional] [default to undefined]
+**open_time** | **string** | Opening time in ET (Eastern Time) format HH:MM. | [default to undefined]
+**close_time** | **string** | Closing time in ET (Eastern Time) format HH:MM. | [default to undefined]
 
 ## Example
 

package/docs/DecreaseOrderRequest.md

@@ -5,7 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**reduce_by** | **number** |  | [default to undefined]
+**reduce_by** | **number** |  | [optional] [default to undefined]
+**reduce_to** | **number** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -14,6 +15,7 @@ import { DecreaseOrderRequest } from 'kalshi-typescript';
 
 const instance: DecreaseOrderRequest = {
     reduce_by,
+    reduce_to,
 };
 ```
 

package/docs/DecreaseOrderResponse.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**order** | [**Order**](Order.md) |  | [optional] [default to undefined]
+**order** | [**Order**](Order.md) |  | [default to undefined]
 
 ## Example
 

package/docs/ErrorResponse.md

@@ -5,7 +5,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**error** | [**ErrorResponseError**](ErrorResponseError.md) |  | [default to undefined]
+**code** | **string** | Error code | [optional] [default to undefined]
+**message** | **string** | Human-readable error message | [optional] [default to undefined]
+**details** | **string** | Additional details about the error, if available | [optional] [default to undefined]
+**service** | **string** | The name of the service that generated the error | [optional] [default to undefined]
 
 ## Example
 
@@ -13,7 +16,10 @@ Name | Type | Description | Notes
 import { ErrorResponse } from 'kalshi-typescript';
 
 const instance: ErrorResponse = {
-    error,
+    code,
+    message,
+    details,
+    service,
 };
 ```
 

package/docs/EventData.md

@@ -0,0 +1,42 @@
+# EventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_ticker** | **string** | Unique identifier for this event. | [default to undefined]
+**series_ticker** | **string** | Unique identifier for the series this event belongs to. | [default to undefined]
+**sub_title** | **string** | Shortened descriptive title for the event. | [default to undefined]
+**title** | **string** | Full title of the event. | [default to undefined]
+**collateral_return_type** | **string** | Specifies how collateral is returned when markets settle (e.g., \'binary\' for standard yes/no markets). | [default to undefined]
+**mutually_exclusive** | **boolean** | If true, only one market in this event can resolve to \'yes\'. If false, multiple markets can resolve to \'yes\'. | [default to undefined]
+**category** | **string** | Event category (deprecated, use series-level category instead). | [default to undefined]
+**strike_date** | **string** | The specific date this event is based on. Only filled when the event uses a date strike (mutually exclusive with strike_period). | [optional] [default to undefined]
+**strike_period** | **string** | The time period this event covers (e.g., \'week\', \'month\'). Only filled when the event uses a period strike (mutually exclusive with strike_date). | [optional] [default to undefined]
+**markets** | [**Array<Market>**](Market.md) | Array of markets associated with this event. Only populated when \'with_nested_markets=true\' is specified in the request. | [optional] [default to undefined]
+**available_on_brokers** | **boolean** | Whether this event is available to trade on brokers. | [default to undefined]
+**product_metadata** | **object** | Additional metadata for the event. | [default to undefined]
+
+## Example
+
+```typescript
+import { EventData } from 'kalshi-typescript';
+
+const instance: EventData = {
+    event_ticker,
+    series_ticker,
+    sub_title,
+    title,
+    collateral_return_type,
+    mutually_exclusive,
+    category,
+    strike_date,
+    strike_period,
+    markets,
+    available_on_brokers,
+    product_metadata,
+};
+```
+
+[[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/EventPosition.md

@@ -5,16 +5,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**event_ticker** | **string** | Unique identifier for events. | [optional] [default to undefined]
-**total_cost** | **number** | Total spent on this event in cents. | [optional] [default to undefined]
-**total_cost_dollars** | **string** | Total spent on this event in dollars. | [optional] [default to undefined]
-**event_exposure** | **number** | Cost of the aggregate event position in cents. | [optional] [default to undefined]
-**event_exposure_dollars** | **string** | Cost of the aggregate event position in dollars. | [optional] [default to undefined]
-**realized_pnl** | **number** | Locked in profit and loss, in cents. | [optional] [default to undefined]
-**realized_pnl_dollars** | **string** | Locked in profit and loss, in dollars. | [optional] [default to undefined]
-**resting_order_count** | **number** | Aggregate size of resting orders in contract units. | [optional] [default to undefined]
-**fees_paid** | **number** | Fees paid on fill orders, in cents. | [optional] [default to undefined]
-**fees_paid_dollars** | **string** | Fees paid on fill orders, in dollars. | [optional] [default to undefined]
+**event_ticker** | **string** | Unique identifier for events | [default to undefined]
+**total_cost** | **number** | Total spent on this event in cents | [default to undefined]
+**total_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
+**total_cost_shares** | **number** | Total number of shares traded on this event (including both YES and NO contracts) | [default to undefined]
+**event_exposure** | **number** | Cost of the aggregate event position in cents | [default to undefined]
+**event_exposure_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
+**realized_pnl** | **number** | Locked in profit and loss, in cents | [default to undefined]
+**realized_pnl_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
+**fees_paid** | **number** | Fees paid on fill orders, in cents | [default to undefined]
+**fees_paid_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
 
 ## Example
 
@@ -25,11 +25,11 @@ const instance: EventPosition = {
     event_ticker,
     total_cost,
     total_cost_dollars,
+    total_cost_shares,
     event_exposure,
     event_exposure_dollars,
     realized_pnl,
     realized_pnl_dollars,
-    resting_order_count,
     fees_paid,
     fees_paid_dollars,
 };

package/docs/EventsApi.md

@@ -5,36 +5,16 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getEvent**](#getevent) | **GET** /events/{event_ticker} | Get Event|
+|[**getEventForecastPercentilesHistory**](#geteventforecastpercentileshistory) | **GET** /series/{series_ticker}/events/{ticker}/forecast_percentile_history | Get Event Forecast Percentile History|
 |[**getEventMetadata**](#geteventmetadata) | **GET** /events/{event_ticker}/metadata | Get Event Metadata|
 |[**getEvents**](#getevents) | **GET** /events | Get Events|
+|[**getMarketCandlesticksByEvent**](#getmarketcandlesticksbyevent) | **GET** /series/{series_ticker}/events/{ticker}/candlesticks | Get Event Candlesticks|
+|[**getMultivariateEvents**](#getmultivariateevents) | **GET** /events/multivariate | Get Multivariate Events|
 
 # **getEvent**
 > GetEventResponse getEvent()
 
-Get data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. 
-
-### Example
-
-```typescript
-import {
-    EventsApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-const apiInstance = new EventsApi(configuration);
-
-let eventTicker: string; //Event ticker (default to undefined)
-let withNestedMarkets: boolean; //If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. (optional) (default to false)
-
-const { status, data } = await apiInstance.getEvent(
-    eventTicker,
-    withNestedMarkets
-);
-```
+ Endpoint for getting data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
 
 ### Parameters
 
@@ -50,7 +30,7 @@ const { status, data } = await apiInstance.getEvent(
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+No authorization required
 
 ### HTTP request headers
 
@@ -62,37 +42,54 @@ const { status, data } = await apiInstance.getEvent(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Event retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
+|**400** | Bad request |  -  |
+|**404** | Event not found |  -  |
+|**401** | Unauthorized |  -  |
 |**500** | Internal server error |  -  |
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+# **getEventForecastPercentilesHistory**
+> GetEventForecastPercentilesHistoryResponse getEventForecastPercentilesHistory()
 
-# **getEventMetadata**
-> GetEventMetadataResponse getEventMetadata()
+Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
 
-Get metadata about an event by its ticker
+### Parameters
 
-### Example
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticker** | [**string**] | The event ticker | defaults to undefined|
+| **seriesTicker** | [**string**] | The series ticker | defaults to undefined|
+| **percentiles** | **Array<number>** | Array of percentile values to retrieve (0-10000, max 10 values) | defaults to undefined|
+| **startTs** | [**number**] | Start timestamp for the range | defaults to undefined|
+| **endTs** | [**number**] | End timestamp for the range | defaults to undefined|
+| **periodInterval** | [**0 | 1 | 60 | 1440**]**Array<0 &#124; 1 &#124; 60 &#124; 1440>** | Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals. | defaults to undefined|
 
-```typescript
-import {
-    EventsApi,
-    Configuration
-} from 'kalshi-typescript';
 
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-const apiInstance = new EventsApi(configuration);
+### Return type
 
-let eventTicker: string; //Event ticker (default to undefined)
+**GetEventForecastPercentilesHistoryResponse**
+
+### Authorization
+
+[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
-const { status, data } = await apiInstance.getEventMetadata(
-    eventTicker
-);
-```
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Event forecast percentile history retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getEventMetadata**
+> GetEventMetadataResponse getEventMetadata()
+
+ Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.
 
 ### Parameters
 
@@ -107,7 +104,7 @@ const { status, data } = await apiInstance.getEventMetadata(
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+No authorization required
 
 ### HTTP request headers
 
@@ -119,58 +116,27 @@ const { status, data } = await apiInstance.getEventMetadata(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Event metadata retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
+|**400** | Bad request |  -  |
+|**404** | Event not found |  -  |
+|**401** | Unauthorized |  -  |
 |**500** | Internal server error |  -  |
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **getEvents**
 > GetEventsResponse getEvents()
 
-Get data about all events.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available. 
-
-### Example
-
-```typescript
-import {
-    EventsApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-const apiInstance = new EventsApi(configuration);
-
-let limit: number; //Number of results per page. Defaults to 100. Maximum value is 200. (optional) (default to 100)
-let cursor: string; //Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. (optional) (default to undefined)
-let withNestedMarkets: boolean; //If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. (optional) (default to false)
-let status: string; //Filter by status. Possible values depend on the endpoint. (optional) (default to undefined)
-let seriesTicker: string; //Filter by series ticker (optional) (default to undefined)
-let minCloseTs: number; //Filter items that close after this Unix timestamp (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getEvents(
-    limit,
-    cursor,
-    withNestedMarkets,
-    status,
-    seriesTicker,
-    minCloseTs
-);
-```
+Filter by event status. Possible values: \'open\', \'closed\', \'settled\'. Leave empty to return events with any status.
 
 ### Parameters
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100|
-| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
-| **withNestedMarkets** | [**boolean**] | If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. | (optional) defaults to false|
-| **status** | [**string**] | Filter by status. Possible values depend on the endpoint. | (optional) defaults to undefined|
+| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200. | (optional) defaults to 200|
+| **cursor** | [**string**] | Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
+| **withNestedMarkets** | [**boolean**] | Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event. | (optional) defaults to false|
+| **withMilestones** | [**boolean**] | If true, includes related milestones as a field alongside events. | (optional) defaults to false|
+| **status** | [**&#39;open&#39; | &#39;closed&#39; | &#39;settled&#39;**]**Array<&#39;open&#39; &#124; &#39;closed&#39; &#124; &#39;settled&#39;>** | Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status. | (optional) defaults to undefined|
 | **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
-| **minCloseTs** | [**number**] | Filter items that close after this Unix timestamp | (optional) defaults to undefined|
+| **minCloseTs** | [**number**] | Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds). | (optional) defaults to undefined|
 
 
 ### Return type
@@ -179,7 +145,7 @@ const { status, data } = await apiInstance.getEvents(
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+No authorization required
 
 ### HTTP request headers
 
@@ -191,9 +157,83 @@ const { status, data } = await apiInstance.getEvents(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Events retrieved successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getMarketCandlesticksByEvent**
+> GetEventCandlesticksResponse getMarketCandlesticksByEvent()
+
+ End-point for returning aggregated data across all markets corresponding to an event.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticker** | [**string**] | The event ticker | defaults to undefined|
+| **seriesTicker** | [**string**] | The series ticker | defaults to undefined|
+| **startTs** | [**number**] | Start timestamp for the range | defaults to undefined|
+| **endTs** | [**number**] | End timestamp for the range | defaults to undefined|
+| **periodInterval** | [**1 | 60 | 1440**]**Array<1 &#124; 60 &#124; 1440>** | Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day. | defaults to undefined|
+
+
+### Return type
+
+**GetEventCandlesticksResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Event candlesticks retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
 |**500** | Internal server error |  -  |
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+# **getMultivariateEvents**
+> GetMultivariateEventsResponse getMultivariateEvents()
+
+Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100|
+| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. | (optional) defaults to undefined|
+| **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
+| **collectionTicker** | [**string**] | Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker. | (optional) defaults to undefined|
+| **withNestedMarkets** | [**boolean**] | Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event. | (optional) defaults to false|
+
+
+### Return type
+
+**GetMultivariateEventsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Multivariate events retrieved successfully |  -  |
+|**400** | Bad request - invalid parameters |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |