kalshi-typescript 3.6.0 → 3.7.0

package/docs/GetRFQsResponse.md

@@ -0,0 +1,22 @@
+# GetRFQsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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
+
+```typescript
+import { GetRFQsResponse } from 'kalshi-typescript';
+
+const instance: GetRFQsResponse = {
+    rfqs,
+    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/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

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

@@ -0,0 +1,22 @@
+# GetSettlementsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**settlements** | [**Array<Settlement>**](Settlement.md) |  | [default to undefined]
+**cursor** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetSettlementsResponse } from 'kalshi-typescript';
+
+const instance: GetSettlementsResponse = {
+    settlements,
+    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/GetStructuredTargetResponse.md

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

@@ -0,0 +1,22 @@
+# GetStructuredTargetsResponse
+
+
+## Properties
+
+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
+
+```typescript
+import { GetStructuredTargetsResponse } from 'kalshi-typescript';
+
+const instance: GetStructuredTargetsResponse = {
+    structured_targets,
+    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/GetSubaccountBalancesResponse.md

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

@@ -0,0 +1,22 @@
+# GetSubaccountTransfersResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transfers** | [**Array<SubaccountTransfer>**](SubaccountTransfer.md) |  | [default to undefined]
+**cursor** | **string** | Cursor for the next page of results. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetSubaccountTransfersResponse } from 'kalshi-typescript';
+
+const instance: GetSubaccountTransfersResponse = {
+    transfers,
+    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/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

@@ -0,0 +1,22 @@
+# GetTradesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**trades** | [**Array<Trade>**](Trade.md) |  | [default to undefined]
+**cursor** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetTradesResponse } from 'kalshi-typescript';
+
+const instance: GetTradesResponse = {
+    trades,
+    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/GetUserDataTimestampResponse.md

@@ -0,0 +1,20 @@
+# GetUserDataTimestampResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**as_of_time** | **string** | Timestamp when user data was last updated. | [default to undefined]
+
+## Example
+
+```typescript
+import { GetUserDataTimestampResponse } from 'kalshi-typescript';
+
+const instance: GetUserDataTimestampResponse = {
+    as_of_time,
+};
+```
+
+[[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/HistoricalApi.md

@@ -0,0 +1,223 @@
+# HistoricalApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getFillsHistorical**](#getfillshistorical) | **GET** /historical/fills | Get Historical Fills|
+|[**getHistoricalCutoff**](#gethistoricalcutoff) | **GET** /historical/cutoff | Get Historical Cutoff Timestamps|
+|[**getHistoricalMarket**](#gethistoricalmarket) | **GET** /historical/markets/{ticker} | Get Historical Market|
+|[**getHistoricalMarkets**](#gethistoricalmarkets) | **GET** /historical/markets | Get Historical Markets|
+|[**getHistoricalOrders**](#gethistoricalorders) | **GET** /historical/orders | Get Historical Orders|
+|[**getMarketCandlesticksHistorical**](#getmarketcandlestickshistorical) | **GET** /historical/markets/{ticker}/candlesticks | Get Historical Market Candlesticks|
+
+# **getFillsHistorical**
+> GetFillsResponse getFillsHistorical()
+
+ Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
+| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
+| **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|
+
+
+### Return type
+
+**GetFillsResponse**
+
+### Authorization
+
+[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Fills retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getHistoricalCutoff**
+> GetHistoricalCutoffResponse getHistoricalCutoff()
+
+Returns the cutoff timestamps that define the boundary between **live** and **historical** data.  ## Cutoff fields - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`. - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`. - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`. 
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetHistoricalCutoffResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Historical cutoff timestamps retrieved successfully |  -  |
+|**500** | Internal server error |  -  |
+
+# **getHistoricalMarket**
+> GetMarketResponse getHistoricalMarket()
+
+ Endpoint for getting data about a specific market by its ticker from the historical database.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticker** | [**string**] | Market ticker | defaults to undefined|
+
+
+### Return type
+
+**GetMarketResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Historical market retrieved successfully |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **getHistoricalMarkets**
+> GetMarketsResponse getHistoricalMarkets()
+
+Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive. 
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 1000. | (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|
+| **tickers** | [**string**] | Filter by specific market tickers. Comma-separated list of market tickers to retrieve. | (optional) defaults to undefined|
+| **eventTicker** | [**string**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
+| **mveFilter** | [**&#39;exclude&#39;**]**Array<&#39;exclude&#39;>** | Filter by multivariate events (combos). By default, MVE markets are included. | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetMarketsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Historical markets retrieved successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**500** | Internal server error |  -  |
+
+# **getHistoricalOrders**
+> GetOrdersResponse getHistoricalOrders()
+
+ Endpoint for getting orders that have been archived to the historical database.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
+| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
+| **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|
+
+
+### Return type
+
+**GetOrdersResponse**
+
+### Authorization
+
+[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Historical orders retrieved successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getMarketCandlesticksHistorical**
+> GetMarketCandlesticksHistoricalResponse getMarketCandlesticksHistorical()
+
+ Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticker** | [**string**] | Market ticker - unique identifier for the specific market | defaults to undefined|
+| **startTs** | [**number**] | Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time. | defaults to undefined|
+| **endTs** | [**number**] | End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time. | defaults to undefined|
+| **periodInterval** | [**1 | 60 | 1440**]**Array<1 &#124; 60 &#124; 1440>** | Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day). | defaults to undefined|
+
+
+### Return type
+
+**GetMarketCandlesticksHistoricalResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Candlesticks retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**404** | Not found |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/IncentiveProgram.md

@@ -0,0 +1,40 @@
+# IncentiveProgram
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the incentive program | [default to undefined]
+**market_id** | **string** | The unique identifier of the market associated with this 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]
+**target_size_fp** | **string** | 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. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IncentiveProgram } from 'kalshi-typescript';
+
+const instance: IncentiveProgram = {
+    id,
+    market_id,
+    market_ticker,
+    incentive_type,
+    start_date,
+    end_date,
+    period_reward,
+    paid_out,
+    discount_factor_bps,
+    target_size,
+    target_size_fp,
+};
+```
+
+[[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 Incentives|
+
+# **getIncentivePrograms**
+> GetIncentiveProgramsResponse getIncentivePrograms()
+
+ List incentives with optional filters. 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/IntraExchangeInstanceTransferRequest.md

@@ -0,0 +1,24 @@
+# IntraExchangeInstanceTransferRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | [**ExchangeInstance**](ExchangeInstance.md) |  | [default to undefined]
+**destination** | [**ExchangeInstance**](ExchangeInstance.md) |  | [default to undefined]
+**amount** | **number** | The amount to transfer in centicents | [default to undefined]
+
+## Example
+
+```typescript
+import { IntraExchangeInstanceTransferRequest } from 'kalshi-typescript';
+
+const instance: IntraExchangeInstanceTransferRequest = {
+    source,
+    destination,
+    amount,
+};
+```
+
+[[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/IntraExchangeInstanceTransferResponse.md

@@ -0,0 +1,20 @@
+# IntraExchangeInstanceTransferResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transfer_id** | **string** | The ID of the transfer that was created | [default to undefined]
+
+## Example
+
+```typescript
+import { IntraExchangeInstanceTransferResponse } from 'kalshi-typescript';
+
+const instance: IntraExchangeInstanceTransferResponse = {
+    transfer_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)

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)