kalshi-typescript 3.0.0 → 3.3.0

package/docs/GetStructuredTargetResponse.md

@@ -1,20 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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/GetTagsForSeriesCategoriesResponse.md

@@ -1,20 +0,0 @@
-# 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/GetTotalRestingOrderValueResponse.md

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

@@ -1,22 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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/IncentiveProgram.md

@@ -1,36 +0,0 @@
-# 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

@@ -1,44 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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)

package/docs/LiveDataApi.md

@@ -1,75 +0,0 @@
-# LiveDataApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getLiveData**](#getlivedata) | **GET** /live_data/{type}/milestone/{milestone_id} | Get Live Data|
-|[**getLiveDatas**](#getlivedatas) | **GET** /live_data/batch | Get Multiple Live Data|
-
-# **getLiveData**
-> GetLiveDataResponse getLiveData()
-
-Get live data for a specific milestone
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **type** | [**string**] | Type of live data | defaults to undefined|
-| **milestoneId** | [**string**] | Milestone ID | defaults to undefined|
-
-
-### Return type
-
-**GetLiveDataResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Live data retrieved successfully |  -  |
-|**404** | Live data not found |  -  |
-|**500** | Internal server error |  -  |
-
-# **getLiveDatas**
-> GetLiveDatasResponse getLiveDatas()
-
-Get live data for multiple milestones
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **milestoneIds** | **Array<string>** | Array of milestone IDs | defaults to undefined|
-
-
-### Return type
-
-**GetLiveDatasResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Live data retrieved successfully |  -  |
-|**500** | Internal server error |  -  |
-

package/docs/LookupBundleRequest.md

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

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

@@ -1,22 +0,0 @@
-# LookupBundleResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bundle_id** | **string** |  | [optional] [default to undefined]
-**price** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { LookupBundleResponse } from 'kalshi-typescript';
-
-const instance: LookupBundleResponse = {
-    bundle_id,
-    price,
-};
-```
-
-[[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/LookupPoint.md

@@ -1,26 +0,0 @@
-# LookupPoint
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**event_ticker** | **string** | Event ticker for the lookup point. | [default to undefined]
-**market_ticker** | **string** | Market ticker for the lookup point. | [default to undefined]
-**selected_markets** | [**Array<TickerPair>**](TickerPair.md) | Markets that were selected for this lookup. | [default to undefined]
-**last_queried_ts** | **string** | Timestamp when this lookup was last queried. | [default to undefined]
-
-## Example
-
-```typescript
-import { LookupPoint } from 'kalshi-typescript';
-
-const instance: LookupPoint = {
-    event_ticker,
-    market_ticker,
-    selected_markets,
-    last_queried_ts,
-};
-```
-
-[[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/LookupTickersForMarketInMultivariateEventCollectionRequest.md

@@ -1,20 +0,0 @@
-# LookupTickersForMarketInMultivariateEventCollectionRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**selected_markets** | [**Array<TickerPair>**](TickerPair.md) | List of selected markets that act as parameters to determine which market is produced. | [default to undefined]
-
-## Example
-
-```typescript
-import { LookupTickersForMarketInMultivariateEventCollectionRequest } from 'kalshi-typescript';
-
-const instance: LookupTickersForMarketInMultivariateEventCollectionRequest = {
-    selected_markets,
-};
-```
-
-[[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/LookupTickersForMarketInMultivariateEventCollectionResponse.md

@@ -1,22 +0,0 @@
-# LookupTickersForMarketInMultivariateEventCollectionResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**event_ticker** | **string** | Event ticker for the looked up market. | [default to undefined]
-**market_ticker** | **string** | Market ticker for the looked up market. | [default to undefined]
-
-## Example
-
-```typescript
-import { LookupTickersForMarketInMultivariateEventCollectionResponse } from 'kalshi-typescript';
-
-const instance: LookupTickersForMarketInMultivariateEventCollectionResponse = {
-    event_ticker,
-    market_ticker,
-};
-```
-
-[[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/MaintenanceWindow.md

@@ -1,22 +0,0 @@
-# MaintenanceWindow
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**start_datetime** | **string** | Start date and time of the maintenance window. | [default to undefined]
-**end_datetime** | **string** | End date and time of the maintenance window. | [default to undefined]
-
-## Example
-
-```typescript
-import { MaintenanceWindow } from 'kalshi-typescript';
-
-const instance: MaintenanceWindow = {
-    start_datetime,
-    end_datetime,
-};
-```
-
-[[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/Market.md

@@ -1,140 +0,0 @@
-# Market
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** |  | [default to undefined]
-**event_ticker** | **string** |  | [default to undefined]
-**market_type** | **string** | Identifies the type of market | [default to undefined]
-**title** | **string** |  | [default to undefined]
-**subtitle** | **string** |  | [default to undefined]
-**yes_sub_title** | **string** | Shortened title for the yes side of this market | [default to undefined]
-**no_sub_title** | **string** | Shortened title for the no side of this market | [default to undefined]
-**created_time** | **string** |  | [default to undefined]
-**open_time** | **string** |  | [default to undefined]
-**close_time** | **string** |  | [default to undefined]
-**expected_expiration_time** | **string** | Time when this market is expected to expire | [optional] [default to undefined]
-**expiration_time** | **string** |  | [default to undefined]
-**latest_expiration_time** | **string** | Latest possible time for this market to expire | [default to undefined]
-**settlement_timer_seconds** | **number** | The amount of time after determination that the market settles | [default to undefined]
-**status** | **string** |  | [default to undefined]
-**response_price_units** | **string** | The units used to express all price related fields | [default to undefined]
-**yes_bid** | **number** |  | [default to undefined]
-**yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**yes_ask** | **number** |  | [default to undefined]
-**yes_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**no_bid** | **number** |  | [default to undefined]
-**no_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**no_ask** | **number** |  | [default to undefined]
-**no_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**last_price** | **number** |  | [default to undefined]
-**last_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**volume** | **number** |  | [default to undefined]
-**volume_24h** | **number** |  | [default to undefined]
-**result** | **string** |  | [default to undefined]
-**can_close_early** | **boolean** |  | [default to undefined]
-**open_interest** | **number** | Number of contracts bought on this market disconsidering netting | [default to undefined]
-**notional_value** | **number** | The total value of a single contract at settlement in cents | [default to undefined]
-**notional_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**previous_yes_bid** | **number** | Price for the highest YES buy offer on this market a day ago in cents | [default to undefined]
-**previous_yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**previous_yes_ask** | **number** | Price for the lowest YES sell offer on this market a day ago in cents | [default to undefined]
-**previous_yes_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**previous_price** | **number** | Price for the last traded YES contract on this market a day ago in cents | [default to undefined]
-**previous_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**liquidity** | **number** | Value for current offers in this market in cents | [default to undefined]
-**liquidity_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**settlement_value** | **number** | The settlement value of the YES/LONG side of the contract in cents. Only filled after determination | [optional] [default to undefined]
-**settlement_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**expiration_value** | **string** | The value that was considered for the settlement | [default to undefined]
-**category** | **string** |  | [default to undefined]
-**risk_limit_cents** | **number** |  | [default to undefined]
-**fee_waiver_expiration_time** | **string** | Time when this market\'s fee waiver expires | [optional] [default to undefined]
-**early_close_condition** | **string** | The condition under which the market can close early | [optional] [default to undefined]
-**tick_size** | **number** | The minimum price movement in the market | [default to undefined]
-**strike_type** | **string** | Strike type defines how the market strike is defined and evaluated | [optional] [default to undefined]
-**floor_strike** | **number** | Minimum expiration value that leads to a YES settlement | [optional] [default to undefined]
-**cap_strike** | **number** | Maximum expiration value that leads to a YES settlement | [optional] [default to undefined]
-**functional_strike** | **string** | Mapping from expiration values to settlement values | [optional] [default to undefined]
-**custom_strike** | **object** | Expiration value for each target that leads to a YES settlement | [optional] [default to undefined]
-**rules_primary** | **string** | A plain language description of the most important market terms | [default to undefined]
-**rules_secondary** | **string** | A plain language description of secondary market terms | [default to undefined]
-**mve_collection_ticker** | **string** | The ticker of the multivariate event collection | [optional] [default to undefined]
-**mve_selected_legs** | [**Array<MveSelectedLeg>**](MveSelectedLeg.md) |  | [optional] [default to undefined]
-**primary_participant_key** | **string** |  | [optional] [default to undefined]
-**price_level_structure** | **string** | Price level structure for this market, defining price ranges and tick sizes | [default to undefined]
-**price_ranges** | [**Array<PriceRange>**](PriceRange.md) | Valid price ranges for orders on this market | [default to undefined]
-
-## Example
-
-```typescript
-import { Market } from 'kalshi-typescript';
-
-const instance: Market = {
-    ticker,
-    event_ticker,
-    market_type,
-    title,
-    subtitle,
-    yes_sub_title,
-    no_sub_title,
-    created_time,
-    open_time,
-    close_time,
-    expected_expiration_time,
-    expiration_time,
-    latest_expiration_time,
-    settlement_timer_seconds,
-    status,
-    response_price_units,
-    yes_bid,
-    yes_bid_dollars,
-    yes_ask,
-    yes_ask_dollars,
-    no_bid,
-    no_bid_dollars,
-    no_ask,
-    no_ask_dollars,
-    last_price,
-    last_price_dollars,
-    volume,
-    volume_24h,
-    result,
-    can_close_early,
-    open_interest,
-    notional_value,
-    notional_value_dollars,
-    previous_yes_bid,
-    previous_yes_bid_dollars,
-    previous_yes_ask,
-    previous_yes_ask_dollars,
-    previous_price,
-    previous_price_dollars,
-    liquidity,
-    liquidity_dollars,
-    settlement_value,
-    settlement_value_dollars,
-    expiration_value,
-    category,
-    risk_limit_cents,
-    fee_waiver_expiration_time,
-    early_close_condition,
-    tick_size,
-    strike_type,
-    floor_strike,
-    cap_strike,
-    functional_strike,
-    custom_strike,
-    rules_primary,
-    rules_secondary,
-    mve_collection_ticker,
-    mve_selected_legs,
-    primary_participant_key,
-    price_level_structure,
-    price_ranges,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)