kalshi-typescript 2.1.3 → 3.0.0

package/docs/GetLiveDataResponse.md

@@ -0,0 +1,20 @@
+# GetLiveDataResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**live_data** | [**LiveData**](LiveData.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetLiveDataResponse } from 'kalshi-typescript';
+
+const instance: GetLiveDataResponse = {
+    live_data,
+};
+```
+
+[[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/GetLiveDatasResponse.md

@@ -0,0 +1,20 @@
+# GetLiveDatasResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**live_datas** | [**Array<LiveData>**](LiveData.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetLiveDatasResponse } from 'kalshi-typescript';
+
+const instance: GetLiveDatasResponse = {
+    live_datas,
+};
+```
+
+[[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/GetMarketCandlesticksResponse.md

@@ -5,7 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**candlesticks** | [**Array<Candlestick>**](Candlestick.md) |  | [optional] [default to undefined]
+**ticker** | **string** | Unique identifier for the market. | [default to undefined]
+**candlesticks** | [**Array<MarketCandlestick>**](MarketCandlestick.md) | Array of candlestick data points for the specified time range. | [default to undefined]
 
 ## Example
 
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
 import { GetMarketCandlesticksResponse } from 'kalshi-typescript';
 
 const instance: GetMarketCandlesticksResponse = {
+    ticker,
     candlesticks,
 };
 ```

package/docs/GetMarketOrderbookResponse.md

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

package/docs/GetMarketResponse.md

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

package/docs/GetMarketsResponse.md

@@ -5,8 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**markets** | [**Array<Market>**](Market.md) |  | [optional] [default to undefined]
-**cursor** | **string** |  | [optional] [default to undefined]
+**markets** | [**Array<Market>**](Market.md) |  | [default to undefined]
+**cursor** | **string** |  | [default to undefined]
 
 ## Example
 

package/docs/GetMilestoneResponse.md

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

package/docs/GetMilestonesResponse.md

@@ -5,7 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**milestones** | [**Array<Milestone>**](Milestone.md) |  | [optional] [default to undefined]
+**milestones** | [**Array<Milestone>**](Milestone.md) | List of milestones. | [default to undefined]
+**cursor** | **string** | Cursor for pagination. | [optional] [default to undefined]
 
 ## Example
 
@@ -14,6 +15,7 @@ import { GetMilestonesResponse } from 'kalshi-typescript';
 
 const instance: GetMilestonesResponse = {
     milestones,
+    cursor,
 };
 ```
 

package/docs/GetMultivariateEventCollectionLookupHistoryResponse.md

@@ -0,0 +1,20 @@
+# GetMultivariateEventCollectionLookupHistoryResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lookup_points** | [**Array<LookupPoint>**](LookupPoint.md) | List of recent lookup points in the collection. | [default to undefined]
+
+## Example
+
+```typescript
+import { GetMultivariateEventCollectionLookupHistoryResponse } from 'kalshi-typescript';
+
+const instance: GetMultivariateEventCollectionLookupHistoryResponse = {
+    lookup_points,
+};
+```
+
+[[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/GetMultivariateEventCollectionResponse.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**collection** | [**MultivariateEventCollection**](MultivariateEventCollection.md) |  | [optional] [default to undefined]
+**multivariate_contract** | [**MultivariateEventCollection**](MultivariateEventCollection.md) |  | [default to undefined]
 
 ## Example
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 import { GetMultivariateEventCollectionResponse } from 'kalshi-typescript';
 
 const instance: GetMultivariateEventCollectionResponse = {
-    collection,
+    multivariate_contract,
 };
 ```
 

package/docs/GetMultivariateEventCollectionsResponse.md

@@ -5,7 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**collections** | [**Array<MultivariateEventCollection>**](MultivariateEventCollection.md) |  | [optional] [default to undefined]
+**multivariate_contracts** | [**Array<MultivariateEventCollection>**](MultivariateEventCollection.md) | List of multivariate event collections. | [default to undefined]
+**cursor** | **string** | The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. | [optional] [default to undefined]
 
 ## Example
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 import { GetMultivariateEventCollectionsResponse } from 'kalshi-typescript';
 
 const instance: GetMultivariateEventCollectionsResponse = {
-    collections,
+    multivariate_contracts,
+    cursor,
 };
 ```
 

package/docs/GetMultivariateEventsResponse.md

@@ -0,0 +1,22 @@
+# GetMultivariateEventsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**Array<EventData>**](EventData.md) | Array of multivariate events matching the query criteria. | [default to undefined]
+**cursor** | **string** | Pagination cursor for the next page. Empty if there are no more results. | [default to undefined]
+
+## Example
+
+```typescript
+import { GetMultivariateEventsResponse } from 'kalshi-typescript';
+
+const instance: GetMultivariateEventsResponse = {
+    events,
+    cursor,
+};
+```
+
+[[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/GetOrderGroupResponse.md

@@ -5,8 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [optional] [default to undefined]
-**orders** | **Array<string>** | List of order IDs that belong to this order group | [optional] [default to undefined]
+**is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [default to undefined]
+**orders** | **Array<string>** | List of order IDs that belong to this order group | [default to undefined]
 
 ## Example
 

package/docs/GetOrderGroupsResponse.md

@@ -6,7 +6,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order_groups** | [**Array<OrderGroup>**](OrderGroup.md) |  | [optional] [default to undefined]
-**cursor** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -15,7 +14,6 @@ import { GetOrderGroupsResponse } from 'kalshi-typescript';
 
 const instance: GetOrderGroupsResponse = {
     order_groups,
-    cursor,
 };
 ```
 

package/docs/GetOrderQueuePositionResponse.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**queue_position** | **number** |  | [optional] [default to undefined]
+**queue_position** | **number** | The position of the order in the queue | [default to undefined]
 
 ## Example
 

package/docs/GetOrderQueuePositionsResponse.md

@@ -0,0 +1,20 @@
+# GetOrderQueuePositionsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**queue_positions** | [**Array<OrderQueuePosition>**](OrderQueuePosition.md) | Queue positions for all matching orders | [default to undefined]
+
+## Example
+
+```typescript
+import { GetOrderQueuePositionsResponse } from 'kalshi-typescript';
+
+const instance: GetOrderQueuePositionsResponse = {
+    queue_positions,
+};
+```
+
+[[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/GetOrdersResponse.md

@@ -5,8 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**orders** | [**Array<Order>**](Order.md) |  | [optional] [default to undefined]
-**cursor** | **string** |  | [optional] [default to undefined]
+**orders** | [**Array<Order>**](Order.md) |  | [default to undefined]
+**cursor** | **string** |  | [default to undefined]
 
 ## Example
 

package/docs/GetPortfolioRestingOrderTotalValueResponse.md

@@ -0,0 +1,20 @@
+# GetPortfolioRestingOrderTotalValueResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_resting_order_value** | **number** | Total value of resting orders in cents | [default to undefined]
+
+## Example
+
+```typescript
+import { GetPortfolioRestingOrderTotalValueResponse } from 'kalshi-typescript';
+
+const instance: GetPortfolioRestingOrderTotalValueResponse = {
+    total_resting_order_value,
+};
+```
+
+[[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/GetPositionsResponse.md

@@ -5,9 +5,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**market_positions** | [**Array<Position>**](Position.md) |  | [optional] [default to undefined]
-**event_positions** | [**Array<EventPosition>**](EventPosition.md) |  | [optional] [default to undefined]
-**cursor** | **string** |  | [optional] [default to undefined]
+**cursor** | **string** | The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. | [optional] [default to undefined]
+**market_positions** | [**Array<MarketPosition>**](MarketPosition.md) | List of market positions | [optional] [default to undefined]
+**event_positions** | [**Array<EventPosition>**](EventPosition.md) | List of event positions | [optional] [default to undefined]
 
 ## Example
 
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
 import { GetPositionsResponse } from 'kalshi-typescript';
 
 const instance: GetPositionsResponse = {
+    cursor,
     market_positions,
     event_positions,
-    cursor,
 };
 ```
 

package/docs/GetQuoteResponse.md

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

package/docs/GetQuotesResponse.md

@@ -5,7 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**quotes** | [**Array<Quote>**](Quote.md) |  | [optional] [default to undefined]
+**quotes** | [**Array<Quote>**](Quote.md) | List of quotes matching the query criteria | [default to undefined]
+**cursor** | **string** | Cursor for pagination to get the next page of results | [optional] [default to undefined]
 
 ## Example
 
@@ -14,6 +15,7 @@ import { GetQuotesResponse } from 'kalshi-typescript';
 
 const instance: GetQuotesResponse = {
     quotes,
+    cursor,
 };
 ```
 

package/docs/GetRFQResponse.md

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

package/docs/GetRFQsResponse.md

@@ -5,7 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**rfqs** | [**Array<RFQ>**](RFQ.md) |  | [optional] [default to undefined]
+**rfqs** | [**Array<RFQ>**](RFQ.md) | List of RFQs matching the query criteria | [default to undefined]
+**cursor** | **string** | Cursor for pagination to get the next page of results | [optional] [default to undefined]
 
 ## Example
 
@@ -14,6 +15,7 @@ import { GetRFQsResponse } from 'kalshi-typescript';
 
 const instance: GetRFQsResponse = {
     rfqs,
+    cursor,
 };
 ```
 

package/docs/GetSeriesFeeChangesResponse.md

@@ -0,0 +1,20 @@
+# GetSeriesFeeChangesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**series_fee_change_arr** | [**Array<SeriesFeeChange>**](SeriesFeeChange.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetSeriesFeeChangesResponse } from 'kalshi-typescript';
+
+const instance: GetSeriesFeeChangesResponse = {
+    series_fee_change_arr,
+};
+```
+
+[[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/GetSeriesListResponse.md

@@ -0,0 +1,20 @@
+# GetSeriesListResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**series** | [**Array<Series>**](Series.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetSeriesListResponse } from 'kalshi-typescript';
+
+const instance: GetSeriesListResponse = {
+    series,
+};
+```
+
+[[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/GetSeriesResponse.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**series** | [**Array<Series>**](Series.md) |  | [optional] [default to undefined]
+**series** | [**Series**](Series.md) |  | [default to undefined]
 
 ## Example
 

package/docs/GetSettlementsResponse.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**settlements** | [**Array<Settlement>**](Settlement.md) |  | [optional] [default to undefined]
+**settlements** | [**Array<Settlement>**](Settlement.md) |  | [default to undefined]
 **cursor** | **string** |  | [optional] [default to undefined]
 
 ## Example

package/docs/GetStructuredTargetsResponse.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **structured_targets** | [**Array<StructuredTarget>**](StructuredTarget.md) |  | [optional] [default to undefined]
+**cursor** | **string** | Pagination cursor for the next page. Empty if there are no more results. | [optional] [default to undefined]
 
 ## Example
 
@@ -14,6 +15,7 @@ import { GetStructuredTargetsResponse } from 'kalshi-typescript';
 
 const instance: GetStructuredTargetsResponse = {
     structured_targets,
+    cursor,
 };
 ```
 

package/docs/GetTagsForSeriesCategoriesResponse.md

@@ -0,0 +1,20 @@
+# GetTagsForSeriesCategoriesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tags_by_categories** | **{ [key: string]: Array<string>; }** | Mapping of series categories to their associated tags | [default to undefined]
+
+## Example
+
+```typescript
+import { GetTagsForSeriesCategoriesResponse } from 'kalshi-typescript';
+
+const instance: GetTagsForSeriesCategoriesResponse = {
+    tags_by_categories,
+};
+```
+
+[[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/GetTradesResponse.md

@@ -5,8 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**trades** | [**Array<Trade>**](Trade.md) |  | [optional] [default to undefined]
-**cursor** | **string** |  | [optional] [default to undefined]
+**trades** | [**Array<Trade>**](Trade.md) |  | [default to undefined]
+**cursor** | **string** |  | [default to undefined]
 
 ## Example
 

package/docs/GetUserDataTimestampResponse.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**timestamp** | **number** |  | [optional] [default to undefined]
+**as_of_time** | **string** | Timestamp when user data was last updated. | [default to undefined]
 
 ## Example
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 import { GetUserDataTimestampResponse } from 'kalshi-typescript';
 
 const instance: GetUserDataTimestampResponse = {
-    timestamp,
+    as_of_time,
 };
 ```
 

package/docs/IncentiveProgram.md

@@ -0,0 +1,36 @@
+# IncentiveProgram
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the incentive program | [default to undefined]
+**market_ticker** | **string** | The ticker symbol of the market associated with this incentive program | [default to undefined]
+**incentive_type** | **string** | Type of incentive program | [default to undefined]
+**start_date** | **string** | Start date of the incentive program | [default to undefined]
+**end_date** | **string** | End date of the incentive program | [default to undefined]
+**period_reward** | **number** | Total reward for the period in centi-cents | [default to undefined]
+**paid_out** | **boolean** | Whether the incentive has been paid out | [default to undefined]
+**discount_factor_bps** | **number** | Discount factor in basis points (optional) | [optional] [default to undefined]
+**target_size** | **number** | Target size for the incentive program (optional) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IncentiveProgram } from 'kalshi-typescript';
+
+const instance: IncentiveProgram = {
+    id,
+    market_ticker,
+    incentive_type,
+    start_date,
+    end_date,
+    period_reward,
+    paid_out,
+    discount_factor_bps,
+    target_size,
+};
+```
+
+[[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/IncentiveProgramsApi.md

@@ -0,0 +1,44 @@
+# IncentiveProgramsApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getIncentivePrograms**](#getincentiveprograms) | **GET** /incentive_programs | Get Volume Incentives|
+
+# **getIncentivePrograms**
+> GetIncentiveProgramsResponse getIncentivePrograms()
+
+ List volume incentives with optional filters. Volume incentives are rewards programs for trading activity on specific markets.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **status** | [**&#39;all&#39; | &#39;active&#39; | &#39;upcoming&#39; | &#39;closed&#39; | &#39;paid_out&#39;**]**Array<&#39;all&#39; &#124; &#39;active&#39; &#124; &#39;upcoming&#39; &#124; &#39;closed&#39; &#124; &#39;paid_out&#39;>** | Status filter. Can be \&quot;all\&quot;, \&quot;active\&quot;, \&quot;upcoming\&quot;, \&quot;closed\&quot;, or \&quot;paid_out\&quot;. Default is \&quot;all\&quot;. | (optional) defaults to undefined|
+| **type** | [**&#39;all&#39; | &#39;liquidity&#39; | &#39;volume&#39;**]**Array<&#39;all&#39; &#124; &#39;liquidity&#39; &#124; &#39;volume&#39;>** | Type filter. Can be \&quot;all\&quot;, \&quot;liquidity\&quot;, or \&quot;volume\&quot;. Default is \&quot;all\&quot;. | (optional) defaults to undefined|
+| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 10000. | (optional) defaults to undefined|
+| **cursor** | [**string**] | Cursor for pagination | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetIncentiveProgramsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Incentive programs retrieved successfully |  -  |
+|**400** | Invalid request parameters |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/LiveData.md

@@ -0,0 +1,24 @@
+# LiveData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | Type of live data | [default to undefined]
+**details** | **{ [key: string]: any; }** | Live data details as a flexible object | [default to undefined]
+**milestone_id** | **string** | Milestone ID | [default to undefined]
+
+## Example
+
+```typescript
+import { LiveData } from 'kalshi-typescript';
+
+const instance: LiveData = {
+    type,
+    details,
+    milestone_id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)