kalshi-typescript 3.5.0 → 3.7.0

package/docs/OrderGroupsApi.md

@@ -0,0 +1,260 @@
+# OrderGroupsApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createOrderGroup**](#createordergroup) | **POST** /portfolio/order_groups/create | Create Order Group|
+|[**deleteOrderGroup**](#deleteordergroup) | **DELETE** /portfolio/order_groups/{order_group_id} | Delete Order Group|
+|[**getOrderGroup**](#getordergroup) | **GET** /portfolio/order_groups/{order_group_id} | Get Order Group|
+|[**getOrderGroups**](#getordergroups) | **GET** /portfolio/order_groups | Get Order Groups|
+|[**resetOrderGroup**](#resetordergroup) | **PUT** /portfolio/order_groups/{order_group_id}/reset | Reset Order Group|
+|[**triggerOrderGroup**](#triggerordergroup) | **PUT** /portfolio/order_groups/{order_group_id}/trigger | Trigger Order Group|
+|[**updateOrderGroupLimit**](#updateordergrouplimit) | **PUT** /portfolio/order_groups/{order_group_id}/limit | Update Order Group Limit|
+
+# **createOrderGroup**
+> CreateOrderGroupResponse createOrderGroup(createOrderGroupRequest)
+
+ Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createOrderGroupRequest** | **CreateOrderGroupRequest**|  | |
+
+
+### Return type
+
+**CreateOrderGroupResponse**
+
+### 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 |
+|-------------|-------------|------------------|
+|**201** | Order group created successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **deleteOrderGroup**
+> object deleteOrderGroup()
+
+ Deletes an order group and cancels all orders within it. This permanently removes the group.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts. | (optional) defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### 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** | Order group deleted successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **getOrderGroup**
+> GetOrderGroupResponse getOrderGroup()
+
+ Retrieves details for a single order group including all order IDs and auto-cancel status.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts. | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetOrderGroupResponse**
+
+### 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** | Order group retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **getOrderGroups**
+> GetOrderGroupsResponse getOrderGroups()
+
+ Retrieves all order groups for the authenticated user.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts. | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetOrderGroupsResponse**
+
+### 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** | Order groups retrieved successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **resetOrderGroup**
+> object resetOrderGroup()
+
+ Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts. | (optional) defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### 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** | Order group reset successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **triggerOrderGroup**
+> object triggerOrderGroup()
+
+ Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts. | (optional) defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### 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** | Order group triggered successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **updateOrderGroupLimit**
+> object updateOrderGroupLimit(updateOrderGroupLimitRequest)
+
+ Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateOrderGroupLimitRequest** | **UpdateOrderGroupLimitRequest**|  | |
+| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### 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** | Order group limit updated successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/OrderQueuePosition.md

@@ -0,0 +1,26 @@
+# OrderQueuePosition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_id** | **string** | The order ID | [default to undefined]
+**market_ticker** | **string** | The market ticker | [default to undefined]
+**queue_position** | **number** | The position of the order in the queue | [default to undefined]
+**queue_position_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 { OrderQueuePosition } from 'kalshi-typescript';
+
+const instance: OrderQueuePosition = {
+    order_id,
+    market_ticker,
+    queue_position,
+    queue_position_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/OrderStatus.md

@@ -0,0 +1,13 @@
+# OrderStatus
+
+The status of an order
+
+## Enum
+
+* `Resting` (value: `'resting'`)
+
+* `Canceled` (value: `'canceled'`)
+
+* `Executed` (value: `'executed'`)
+
+[[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/Orderbook.md

@@ -0,0 +1,27 @@
+# Orderbook
+
+Legacy integer-count orderbook (will be deprecated). Prefer OrderbookCountFp / orderbook_fp for fixed-point contract counts.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_true** | **Array<Array<number>>** |  | [optional] [default to undefined]
+**_false** | **Array<Array<number>>** |  | [optional] [default to undefined]
+**yes_dollars** | **Array<Array<string>>** |  | [default to undefined]
+**no_dollars** | **Array<Array<string>>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Orderbook } from 'kalshi-typescript';
+
+const instance: Orderbook = {
+    _true,
+    _false,
+    yes_dollars,
+    no_dollars,
+};
+```
+
+[[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/OrderbookCountFp.md

@@ -0,0 +1,23 @@
+# OrderbookCountFp
+
+Orderbook with fixed-point contract counts (fp) in all dollar price levels.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**yes_dollars** | **Array<Array<string>>** |  | [default to undefined]
+**no_dollars** | **Array<Array<string>>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { OrderbookCountFp } from 'kalshi-typescript';
+
+const instance: OrderbookCountFp = {
+    yes_dollars,
+    no_dollars,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)