kalshi-typescript 3.6.0 → 3.7.0

package/docs/BatchCreateOrdersRequest.md

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

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

@@ -0,0 +1,20 @@
+# BatchGetMarketCandlesticksResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**markets** | [**Array<MarketCandlesticksResponse>**](MarketCandlesticksResponse.md) | Array of market candlestick data, one entry per requested market. | [default to undefined]
+
+## Example
+
+```typescript
+import { BatchGetMarketCandlesticksResponse } from 'kalshi-typescript';
+
+const instance: BatchGetMarketCandlesticksResponse = {
+    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/BidAskDistribution.md

@@ -0,0 +1,34 @@
+# BidAskDistribution
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**open** | **number** | Offer price on the market at the start of the candlestick period (in cents). | [default to undefined]
+**open_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**low** | **number** | Lowest offer price on the market during the candlestick period (in cents). | [default to undefined]
+**low_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**high** | **number** | Highest offer price on the market during the candlestick period (in cents). | [default to undefined]
+**high_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**close** | **number** | Offer price on the market at the end of the candlestick period (in cents). | [default to undefined]
+**close_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+
+## Example
+
+```typescript
+import { BidAskDistribution } from 'kalshi-typescript';
+
+const instance: BidAskDistribution = {
+    open,
+    open_dollars,
+    low,
+    low_dollars,
+    high,
+    high_dollars,
+    close,
+    close_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/BidAskDistributionHistorical.md

@@ -0,0 +1,26 @@
+# BidAskDistributionHistorical
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**open** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**low** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**high** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**close** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+
+## Example
+
+```typescript
+import { BidAskDistributionHistorical } from 'kalshi-typescript';
+
+const instance: BidAskDistributionHistorical = {
+    open,
+    low,
+    high,
+    close,
+};
+```
+
+[[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/CancelOrderResponse.md

@@ -0,0 +1,24 @@
+# CancelOrderResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | [**Order**](Order.md) |  | [default to undefined]
+**reduced_by** | **number** |  | [default to undefined]
+**reduced_by_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. | [default to undefined]
+
+## Example
+
+```typescript
+import { CancelOrderResponse } from 'kalshi-typescript';
+
+const instance: CancelOrderResponse = {
+    order,
+    reduced_by,
+    reduced_by_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/CommunicationsApi.md

@@ -0,0 +1,404 @@
+# CommunicationsApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**acceptQuote**](#acceptquote) | **PUT** /communications/quotes/{quote_id}/accept | Accept Quote|
+|[**confirmQuote**](#confirmquote) | **PUT** /communications/quotes/{quote_id}/confirm | Confirm Quote|
+|[**createQuote**](#createquote) | **POST** /communications/quotes | Create Quote|
+|[**createRFQ**](#createrfq) | **POST** /communications/rfqs | Create RFQ|
+|[**deleteQuote**](#deletequote) | **DELETE** /communications/quotes/{quote_id} | Delete Quote|
+|[**deleteRFQ**](#deleterfq) | **DELETE** /communications/rfqs/{rfq_id} | Delete RFQ|
+|[**getCommunicationsID**](#getcommunicationsid) | **GET** /communications/id | Get Communications ID|
+|[**getQuote**](#getquote) | **GET** /communications/quotes/{quote_id} | Get Quote|
+|[**getQuotes**](#getquotes) | **GET** /communications/quotes | Get Quotes|
+|[**getRFQ**](#getrfq) | **GET** /communications/rfqs/{rfq_id} | Get RFQ|
+|[**getRFQs**](#getrfqs) | **GET** /communications/rfqs | Get RFQs|
+
+# **acceptQuote**
+> acceptQuote(acceptQuoteRequest)
+
+ Endpoint for accepting a quote. This will require the quoter to confirm
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptQuoteRequest** | **AcceptQuoteRequest**|  | |
+| **quoteId** | [**string**] | Quote ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+|**204** | Quote accepted successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **confirmQuote**
+> confirmQuote()
+
+ Endpoint for confirming a quote. This will start a timer for order execution
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+| **quoteId** | [**string**] | Quote ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+|**204** | Quote confirmed successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **createQuote**
+> CreateQuoteResponse createQuote(createQuoteRequest)
+
+ Endpoint for creating a quote in response to an RFQ
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createQuoteRequest** | **CreateQuoteRequest**|  | |
+
+
+### Return type
+
+**CreateQuoteResponse**
+
+### 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** | Quote created successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **createRFQ**
+> CreateRFQResponse createRFQ(createRFQRequest)
+
+ Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createRFQRequest** | **CreateRFQRequest**|  | |
+
+
+### Return type
+
+**CreateRFQResponse**
+
+### 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** | RFQ created successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**409** | Conflict - resource already exists or cannot be modified |  -  |
+|**500** | Internal server error |  -  |
+
+# **deleteQuote**
+> deleteQuote()
+
+ Endpoint for deleting a quote, which means it can no longer be accepted.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **quoteId** | [**string**] | Quote ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+|**204** | Quote deleted successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **deleteRFQ**
+> deleteRFQ()
+
+ Endpoint for deleting an RFQ by ID
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rfqId** | [**string**] | RFQ ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+|**204** | RFQ deleted successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **getCommunicationsID**
+> GetCommunicationsIDResponse getCommunicationsID()
+
+ Endpoint for getting the communications ID of the logged-in user.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetCommunicationsIDResponse**
+
+### 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** | Communications ID retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getQuote**
+> GetQuoteResponse getQuote()
+
+ Endpoint for getting a particular quote
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **quoteId** | [**string**] | Quote ID | defaults to undefined|
+
+
+### Return type
+
+**GetQuoteResponse**
+
+### 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** | Quote retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **getQuotes**
+> GetQuotesResponse getQuotes()
+
+ Endpoint for getting quotes
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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|
+| **eventTicker** | [**string**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
+| **marketTicker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
+| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 500. | (optional) defaults to 500|
+| **status** | [**string**] | Filter quotes by status | (optional) defaults to undefined|
+| **quoteCreatorUserId** | [**string**] | Filter quotes by quote creator user ID | (optional) defaults to undefined|
+| **rfqCreatorUserId** | [**string**] | Filter quotes by RFQ creator user ID | (optional) defaults to undefined|
+| **rfqCreatorSubtraderId** | [**string**] | Filter quotes by RFQ creator subtrader ID (FCM members only) | (optional) defaults to undefined|
+| **rfqId** | [**string**] | Filter quotes by RFQ ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetQuotesResponse**
+
+### 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** | Quotes retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getRFQ**
+> GetRFQResponse getRFQ()
+
+ Endpoint for getting a single RFQ by id
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rfqId** | [**string**] | RFQ ID | defaults to undefined|
+
+
+### Return type
+
+**GetRFQResponse**
+
+### 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** | RFQ retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **getRFQs**
+> GetRFQsResponse getRFQs()
+
+ Endpoint for getting RFQs
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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|
+| **eventTicker** | [**string**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
+| **marketTicker** | [**string**] | Filter by market ticker | (optional) 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|
+| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100. | (optional) defaults to 100|
+| **status** | [**string**] | Filter RFQs by status | (optional) defaults to undefined|
+| **creatorUserId** | [**string**] | Filter RFQs by creator user ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetRFQsResponse**
+
+### 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** | RFQs retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/CreateApiKeyRequest.md

@@ -0,0 +1,24 @@
+# CreateApiKeyRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name for the API key. This helps identify the key\'s purpose | [default to undefined]
+**public_key** | **string** | RSA public key in PEM format. This will be used to verify signatures on API requests | [default to undefined]
+**scopes** | **Array<string>** | List of scopes to grant to the API key. Valid values are \'read\' and \'write\'. If \'write\' is included, \'read\' must also be included. Defaults to full access ([\'read\', \'write\']) if not provided. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateApiKeyRequest } from 'kalshi-typescript';
+
+const instance: CreateApiKeyRequest = {
+    name,
+    public_key,
+    scopes,
+};
+```
+
+[[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/CreateApiKeyResponse.md

@@ -0,0 +1,20 @@
+# CreateApiKeyResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_key_id** | **string** | Unique identifier for the newly created API key | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateApiKeyResponse } from 'kalshi-typescript';
+
+const instance: CreateApiKeyResponse = {
+    api_key_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/CreateMarketInMultivariateEventCollectionRequest.md

@@ -0,0 +1,22 @@
+# CreateMarketInMultivariateEventCollectionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**selected_markets** | [**Array<TickerPair>**](TickerPair.md) | List of selected markets that act as parameters to determine which market is created. | [default to undefined]
+**with_market_payload** | **boolean** | Whether to include the market payload in the response. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateMarketInMultivariateEventCollectionRequest } from 'kalshi-typescript';
+
+const instance: CreateMarketInMultivariateEventCollectionRequest = {
+    selected_markets,
+    with_market_payload,
+};
+```
+
+[[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/CreateMarketInMultivariateEventCollectionResponse.md

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

@@ -0,0 +1,24 @@
+# CreateOrderGroupRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subaccount** | **number** | Optional subaccount number to use for this order group (0 for primary, 1-32 for subaccounts) | [optional] [default to 0]
+**contracts_limit** | **number** | Specifies the maximum number of contracts that can be matched within this group over a rolling 15-second window. Whole contracts only. Provide contracts_limit or contracts_limit_fp; if both provided they must match. | [optional] [default to undefined]
+**contracts_limit_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 { CreateOrderGroupRequest } from 'kalshi-typescript';
+
+const instance: CreateOrderGroupRequest = {
+    subaccount,
+    contracts_limit,
+    contracts_limit_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)