kalshi-typescript 3.0.0 → 3.4.0

package/docs/MultivariateApi.md

@@ -1,188 +0,0 @@
-# MultivariateApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createMarketInMultivariateEventCollection**](#createmarketinmultivariateeventcollection) | **POST** /multivariate_event_collections/{collection_ticker} | Create Market In Multivariate Event Collection|
-|[**getMultivariateEventCollection**](#getmultivariateeventcollection) | **GET** /multivariate_event_collections/{collection_ticker} | Get Multivariate Event Collection|
-|[**getMultivariateEventCollectionLookupHistory**](#getmultivariateeventcollectionlookuphistory) | **GET** /multivariate_event_collections/{collection_ticker}/lookup | Get Multivariate Event Collection Lookup History|
-|[**getMultivariateEventCollections**](#getmultivariateeventcollections) | **GET** /multivariate_event_collections | Get Multivariate Event Collections|
-|[**lookupTickersForMarketInMultivariateEventCollection**](#lookuptickersformarketinmultivariateeventcollection) | **PUT** /multivariate_event_collections/{collection_ticker}/lookup | Lookup Tickers For Market In Multivariate Event Collection|
-
-# **createMarketInMultivariateEventCollection**
-> CreateMarketInMultivariateEventCollectionResponse createMarketInMultivariateEventCollection(createMarketInMultivariateEventCollectionRequest)
-
- Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createMarketInMultivariateEventCollectionRequest** | **CreateMarketInMultivariateEventCollectionRequest**|  | |
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-
-
-### Return type
-
-**CreateMarketInMultivariateEventCollectionResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Market created successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**500** | Internal server error |  -  |
-
-# **getMultivariateEventCollection**
-> GetMultivariateEventCollectionResponse getMultivariateEventCollection()
-
- Endpoint for getting data about a multivariate event collection by its ticker.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-
-
-### Return type
-
-**GetMultivariateEventCollectionResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Collection retrieved successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**404** | Resource not found |  -  |
-|**500** | Internal server error |  -  |
-
-# **getMultivariateEventCollectionLookupHistory**
-> GetMultivariateEventCollectionLookupHistoryResponse getMultivariateEventCollectionLookupHistory()
-
- Endpoint for retrieving which markets in an event collection were recently looked up.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-| **lookbackSeconds** | [**10 | 60 | 300 | 3600**]**Array<10 &#124; 60 &#124; 300 &#124; 3600>** | Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600. | defaults to undefined|
-
-
-### Return type
-
-**GetMultivariateEventCollectionLookupHistoryResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Lookup history retrieved successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**500** | Internal server error |  -  |
-
-# **getMultivariateEventCollections**
-> GetMultivariateEventCollectionsResponse getMultivariateEventCollections()
-
- Endpoint for getting data about multivariate event collections.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **status** | [**&#39;unopened&#39; | &#39;open&#39; | &#39;closed&#39;**]**Array<&#39;unopened&#39; &#124; &#39;open&#39; &#124; &#39;closed&#39;>** | Only return collections of a certain status. Can be unopened, open, or closed. | (optional) defaults to undefined|
-| **associatedEventTicker** | [**string**] | Only return collections associated with a particular event ticker. | (optional) defaults to undefined|
-| **seriesTicker** | [**string**] | Only return collections with a particular series ticker. | (optional) defaults to undefined|
-| **limit** | [**number**] | Specify the maximum number of results. | (optional) defaults to undefined|
-| **cursor** | [**string**] | The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point. | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetMultivariateEventCollectionsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Collections retrieved successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**500** | Internal server error |  -  |
-
-# **lookupTickersForMarketInMultivariateEventCollection**
-> LookupTickersForMarketInMultivariateEventCollectionResponse lookupTickersForMarketInMultivariateEventCollection(lookupTickersForMarketInMultivariateEventCollectionRequest)
-
- Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **lookupTickersForMarketInMultivariateEventCollectionRequest** | **LookupTickersForMarketInMultivariateEventCollectionRequest**|  | |
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-
-
-### Return type
-
-**LookupTickersForMarketInMultivariateEventCollectionResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Market looked up successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
-|**500** | Internal server error |  -  |
-

package/docs/MultivariateCollectionsApi.md

@@ -1,184 +0,0 @@
-# MultivariateCollectionsApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getMultivariateEventCollection**](#getmultivariateeventcollection) | **GET** /multivariate_event_collections/{collection_ticker} | Get Multivariate Event Collection|
-|[**getMultivariateEventCollections**](#getmultivariateeventcollections) | **GET** /multivariate_event_collections | Get Multivariate Event Collections|
-|[**lookupMultivariateEventCollectionBundle**](#lookupmultivariateeventcollectionbundle) | **POST** /multivariate_event_collections/{collection_ticker}/lookup | Lookup Multivariate Event Collection Bundle|
-
-# **getMultivariateEventCollection**
-> GetMultivariateEventCollectionResponse getMultivariateEventCollection()
-
-Get a single multivariate event collection by ticker
-
-### Example
-
-```typescript
-import {
-    MultivariateCollectionsApi,
-    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 MultivariateCollectionsApi(configuration);
-
-let collectionTicker: string; //Collection ticker (default to undefined)
-
-const { status, data } = await apiInstance.getMultivariateEventCollection(
-    collectionTicker
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-
-
-### Return type
-
-**GetMultivariateEventCollectionResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Collection retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
-|**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)
-
-# **getMultivariateEventCollections**
-> GetMultivariateEventCollectionsResponse getMultivariateEventCollections()
-
-Get all multivariate event collections
-
-### Example
-
-```typescript
-import {
-    MultivariateCollectionsApi,
-    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 MultivariateCollectionsApi(configuration);
-
-let status: string; //Filter by multivariate collection status (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getMultivariateEventCollections(
-    status
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **status** | [**string**] | Filter by multivariate collection status | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetMultivariateEventCollectionsResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Collections retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**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)
-
-# **lookupMultivariateEventCollectionBundle**
-> LookupBundleResponse lookupMultivariateEventCollectionBundle(lookupBundleRequest)
-
-Lookup a bundle in a multivariate event collection
-
-### Example
-
-```typescript
-import {
-    MultivariateCollectionsApi,
-    Configuration,
-    LookupBundleRequest
-} 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 MultivariateCollectionsApi(configuration);
-
-let collectionTicker: string; //Collection ticker (default to undefined)
-let lookupBundleRequest: LookupBundleRequest; //
-
-const { status, data } = await apiInstance.lookupMultivariateEventCollectionBundle(
-    collectionTicker,
-    lookupBundleRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **lookupBundleRequest** | **LookupBundleRequest**|  | |
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-
-
-### Return type
-
-**LookupBundleResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Bundle lookup successful |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
-|**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)

package/docs/MultivariateEventCollection.md

@@ -1,46 +0,0 @@
-# MultivariateEventCollection
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**collection_ticker** | **string** | Unique identifier for the collection. | [default to undefined]
-**series_ticker** | **string** | Series associated with the collection. Events produced in the collection will be associated with this series. | [default to undefined]
-**title** | **string** | Title of the collection. | [default to undefined]
-**description** | **string** | Short description of the collection. | [default to undefined]
-**open_date** | **string** | The open date of the collection. Before this time, the collection cannot be interacted with. | [default to undefined]
-**close_date** | **string** | The close date of the collection. After this time, the collection cannot be interacted with. | [default to undefined]
-**associated_events** | [**Array<AssociatedEvent>**](AssociatedEvent.md) | List of events with their individual configuration. | [default to undefined]
-**associated_event_tickers** | **Array<string>** | [DEPRECATED - Use associated_events instead] A list of events associated with the collection. Markets in these events can be passed as inputs to the Lookup and Create endpoints. | [default to undefined]
-**is_ordered** | **boolean** | Whether the collection is ordered. If true, the order of markets passed into Lookup/Create affects the output. If false, the order does not matter. | [default to undefined]
-**is_single_market_per_event** | **boolean** | [DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create. | [default to undefined]
-**is_all_yes** | **boolean** | [DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of \'yes\' may be used. | [default to undefined]
-**size_min** | **number** | The minimum number of markets that must be passed into Lookup/Create (inclusive). | [default to undefined]
-**size_max** | **number** | The maximum number of markets that must be passed into Lookup/Create (inclusive). | [default to undefined]
-**functional_description** | **string** | A functional description of the collection describing how inputs affect the output. | [default to undefined]
-
-## Example
-
-```typescript
-import { MultivariateEventCollection } from 'kalshi-typescript';
-
-const instance: MultivariateEventCollection = {
-    collection_ticker,
-    series_ticker,
-    title,
-    description,
-    open_date,
-    close_date,
-    associated_events,
-    associated_event_tickers,
-    is_ordered,
-    is_single_market_per_event,
-    is_all_yes,
-    size_min,
-    size_max,
-    functional_description,
-};
-```
-
-[[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/MultivariateEventCollectionEventsInner.md

@@ -1,26 +0,0 @@
-# MultivariateEventCollectionEventsInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** |  | [optional] [default to undefined]
-**is_yes_only** | **boolean** |  | [optional] [default to undefined]
-**size_min** | **number** |  | [optional] [default to undefined]
-**size_max** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MultivariateEventCollectionEventsInner } from 'kalshi-typescript';
-
-const instance: MultivariateEventCollectionEventsInner = {
-    ticker,
-    is_yes_only,
-    size_min,
-    size_max,
-};
-```
-
-[[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/MveSelectedLeg.md

@@ -1,24 +0,0 @@
-# MveSelectedLeg
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**event_ticker** | **string** | Unique identifier for the selected event | [optional] [default to undefined]
-**market_ticker** | **string** | Unique identifier for the selected market | [optional] [default to undefined]
-**side** | **string** | The side of the selected market | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MveSelectedLeg } from 'kalshi-typescript';
-
-const instance: MveSelectedLeg = {
-    event_ticker,
-    market_ticker,
-    side,
-};
-```
-
-[[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/Order.md

@@ -1,78 +0,0 @@
-# Order
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order_id** | **string** |  | [default to undefined]
-**user_id** | **string** | Unique identifier for users | [default to undefined]
-**client_order_id** | **string** |  | [default to undefined]
-**ticker** | **string** |  | [default to undefined]
-**side** | **string** |  | [default to undefined]
-**action** | **string** |  | [default to undefined]
-**type** | **string** |  | [default to undefined]
-**status** | [**OrderStatus**](OrderStatus.md) |  | [default to undefined]
-**yes_price** | **number** |  | [default to undefined]
-**no_price** | **number** |  | [default to undefined]
-**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**fill_count** | **number** | The number of contracts that have been filled | [default to undefined]
-**remaining_count** | **number** |  | [default to undefined]
-**initial_count** | **number** | The initial size of the order (contract units) | [default to undefined]
-**taker_fees** | **number** | Fees paid on filled taker contracts, in cents | [default to undefined]
-**maker_fees** | **number** | Fees paid on filled maker contracts, in cents | [default to undefined]
-**taker_fill_cost** | **number** | The cost of filled taker orders in cents | [default to undefined]
-**maker_fill_cost** | **number** | The cost of filled maker orders in cents | [default to undefined]
-**taker_fill_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**maker_fill_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**queue_position** | **number** | **DEPRECATED**: This field is deprecated and will always return 0. Please use the GET /portfolio/orders/{order_id}/queue_position endpoint instead | [default to undefined]
-**taker_fees_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**maker_fees_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**expiration_time** | **string** |  | [optional] [default to undefined]
-**created_time** | **string** |  | [optional] [default to undefined]
-**last_update_time** | **string** | The last update to an order (modify, cancel, fill) | [optional] [default to undefined]
-**self_trade_prevention_type** | [**SelfTradePreventionType**](SelfTradePreventionType.md) |  | [optional] [default to undefined]
-**order_group_id** | **string** | The order group this order is part of | [optional] [default to undefined]
-**cancel_order_on_pause** | **boolean** | If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Order } from 'kalshi-typescript';
-
-const instance: Order = {
-    order_id,
-    user_id,
-    client_order_id,
-    ticker,
-    side,
-    action,
-    type,
-    status,
-    yes_price,
-    no_price,
-    yes_price_dollars,
-    no_price_dollars,
-    fill_count,
-    remaining_count,
-    initial_count,
-    taker_fees,
-    maker_fees,
-    taker_fill_cost,
-    maker_fill_cost,
-    taker_fill_cost_dollars,
-    maker_fill_cost_dollars,
-    queue_position,
-    taker_fees_dollars,
-    maker_fees_dollars,
-    expiration_time,
-    created_time,
-    last_update_time,
-    self_trade_prevention_type,
-    order_group_id,
-    cancel_order_on_pause,
-};
-```
-
-[[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/OrderGroup.md

@@ -1,22 +0,0 @@
-# OrderGroup
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | Unique identifier for the order group | [default to undefined]
-**is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [default to undefined]
-
-## Example
-
-```typescript
-import { OrderGroup } from 'kalshi-typescript';
-
-const instance: OrderGroup = {
-    id,
-    is_auto_cancel_enabled,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)