kalshi-typescript 3.5.0 → 3.7.0

package/docs/AccountApi.md

@@ -0,0 +1,38 @@
+# AccountApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getAccountApiLimits**](#getaccountapilimits) | **GET** /account/limits | Get Account API Limits|
+
+# **getAccountApiLimits**
+> GetAccountApiLimitsResponse getAccountApiLimits()
+
+ Endpoint to retrieve the API tier limits associated with the authenticated user.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetAccountApiLimitsResponse**
+
+### 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** | Account API tier limits retrieved successfully |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/AmendOrderRequest.md

@@ -0,0 +1,42 @@
+# AmendOrderRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subaccount** | **number** | Optional subaccount number to use for this amendment (0 for primary, 1-32 for subaccounts) | [optional] [default to 0]
+**ticker** | **string** | Market ticker | [default to undefined]
+**side** | **string** | Side of the order | [default to undefined]
+**action** | **string** | Action of the order | [default to undefined]
+**client_order_id** | **string** | The original client-specified order ID to be amended | [optional] [default to undefined]
+**updated_client_order_id** | **string** | The new client-specified order ID after amendment | [optional] [default to undefined]
+**yes_price** | **number** | Updated yes price for the order in cents | [optional] [default to undefined]
+**no_price** | **number** | Updated no price for the order in cents | [optional] [default to undefined]
+**yes_price_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. | [optional] [default to undefined]
+**no_price_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. | [optional] [default to undefined]
+**count** | **number** | Updated quantity for the order (whole contracts only). If updating quantity, provide count or count_fp; if both provided they must match. | [optional] [default to undefined]
+**count_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 { AmendOrderRequest } from 'kalshi-typescript';
+
+const instance: AmendOrderRequest = {
+    subaccount,
+    ticker,
+    side,
+    action,
+    client_order_id,
+    updated_client_order_id,
+    yes_price,
+    no_price,
+    yes_price_dollars,
+    no_price_dollars,
+    count,
+    count_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/AmendOrderResponse.md

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

@@ -0,0 +1,26 @@
+# Announcement
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | The type of the announcement. | [default to undefined]
+**message** | **string** | The message contained within the announcement. | [default to undefined]
+**delivery_time** | **string** | The time the announcement was delivered. | [default to undefined]
+**status** | **string** | The current status of this announcement. | [default to undefined]
+
+## Example
+
+```typescript
+import { Announcement } from 'kalshi-typescript';
+
+const instance: Announcement = {
+    type,
+    message,
+    delivery_time,
+    status,
+};
+```
+
+[[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/ApiKey.md

@@ -0,0 +1,24 @@
+# ApiKey
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_key_id** | **string** | Unique identifier for the API key | [default to undefined]
+**name** | **string** | User-provided name for the API key | [default to undefined]
+**scopes** | **Array<string>** | List of scopes granted to this API key. Valid values are \'read\' and \'write\'. | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiKey } from 'kalshi-typescript';
+
+const instance: ApiKey = {
+    api_key_id,
+    name,
+    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/ApiKeysApi.md

@@ -0,0 +1,145 @@
+# ApiKeysApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createApiKey**](#createapikey) | **POST** /api_keys | Create API Key|
+|[**deleteApiKey**](#deleteapikey) | **DELETE** /api_keys/{api_key} | Delete API Key|
+|[**generateApiKey**](#generateapikey) | **POST** /api_keys/generate | Generate API Key|
+|[**getApiKeys**](#getapikeys) | **GET** /api_keys | Get API Keys|
+
+# **createApiKey**
+> CreateApiKeyResponse createApiKey(createApiKeyRequest)
+
+ Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createApiKeyRequest** | **CreateApiKeyRequest**|  | |
+
+
+### Return type
+
+**CreateApiKeyResponse**
+
+### 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** | API key created successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden - insufficient API usage level |  -  |
+|**500** | Internal server error |  -  |
+
+# **deleteApiKey**
+> deleteApiKey()
+
+ Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiKey** | [**string**] | API key ID to delete | 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**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | API key successfully deleted |  -  |
+|**400** | Bad request - invalid API key ID |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | API key not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **generateApiKey**
+> GenerateApiKeyResponse generateApiKey(generateApiKeyRequest)
+
+ Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **generateApiKeyRequest** | **GenerateApiKeyRequest**|  | |
+
+
+### Return type
+
+**GenerateApiKeyResponse**
+
+### 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** | API key generated successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getApiKeys**
+> GetApiKeysResponse getApiKeys()
+
+ Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetApiKeysResponse**
+
+### 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** | List of API keys retrieved successfully |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/ApplySubaccountTransferRequest.md

@@ -0,0 +1,26 @@
+# ApplySubaccountTransferRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_transfer_id** | **string** | Unique client-provided transfer ID for idempotency. | [default to undefined]
+**from_subaccount** | **number** | Source subaccount number (0 for primary, 1-32 for numbered subaccounts). | [default to undefined]
+**to_subaccount** | **number** | Destination subaccount number (0 for primary, 1-32 for numbered subaccounts). | [default to undefined]
+**amount_cents** | **number** | Amount to transfer in cents. | [default to undefined]
+
+## Example
+
+```typescript
+import { ApplySubaccountTransferRequest } from 'kalshi-typescript';
+
+const instance: ApplySubaccountTransferRequest = {
+    client_transfer_id,
+    from_subaccount,
+    to_subaccount,
+    amount_cents,
+};
+```
+
+[[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/AssociatedEvent.md

@@ -0,0 +1,28 @@
+# AssociatedEvent
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ticker** | **string** | The event ticker. | [default to undefined]
+**is_yes_only** | **boolean** | Whether only the \'yes\' side can be used for this event. | [default to undefined]
+**size_max** | **number** | Maximum number of markets from this event (inclusive). Null means no limit. | [optional] [default to undefined]
+**size_min** | **number** | Minimum number of markets from this event (inclusive). Null means no limit. | [optional] [default to undefined]
+**active_quoters** | **Array<string>** | List of active quoters for this event. | [default to undefined]
+
+## Example
+
+```typescript
+import { AssociatedEvent } from 'kalshi-typescript';
+
+const instance: AssociatedEvent = {
+    ticker,
+    is_yes_only,
+    size_max,
+    size_min,
+    active_quoters,
+};
+```
+
+[[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/BatchCancelOrdersIndividualResponse.md

@@ -0,0 +1,28 @@
+# BatchCancelOrdersIndividualResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_id** | **string** | The order ID to identify which order had an error during batch cancellation | [default to undefined]
+**order** | [**Order**](Order.md) |  | [optional] [default to undefined]
+**reduced_by** | **number** | The number of contracts that were successfully canceled from this order | [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]
+**error** | [**ErrorResponse**](ErrorResponse.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BatchCancelOrdersIndividualResponse } from 'kalshi-typescript';
+
+const instance: BatchCancelOrdersIndividualResponse = {
+    order_id,
+    order,
+    reduced_by,
+    reduced_by_fp,
+    error,
+};
+```
+
+[[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/BatchCancelOrdersRequest.md

@@ -0,0 +1,22 @@
+# BatchCancelOrdersRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **Array<string>** | An array of order IDs to cancel | [optional] [default to undefined]
+**orders** | [**Array<BatchCancelOrdersRequestOrder>**](BatchCancelOrdersRequestOrder.md) | An array of orders to cancel, each optionally specifying a subaccount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BatchCancelOrdersRequest } from 'kalshi-typescript';
+
+const instance: BatchCancelOrdersRequest = {
+    ids,
+    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/BatchCancelOrdersRequestOrder.md

@@ -0,0 +1,22 @@
+# BatchCancelOrdersRequestOrder
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_id** | **string** | Order ID to cancel | [default to undefined]
+**subaccount** | **number** | Optional subaccount number to use for this cancellation (0 for primary, 1-32 for subaccounts) | [optional] [default to 0]
+
+## Example
+
+```typescript
+import { BatchCancelOrdersRequestOrder } from 'kalshi-typescript';
+
+const instance: BatchCancelOrdersRequestOrder = {
+    order_id,
+    subaccount,
+};
+```
+
+[[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/BatchCancelOrdersResponse.md

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

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