kalshi-typescript 3.22.0 → 3.24.0

package/docs/CommunicationsApi.md

@@ -6,16 +6,20 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
 |------------- | ------------- | -------------|
 |[**acceptBlockTradeProposal**](#acceptblocktradeproposal) | **POST** /communications/block-trade-proposals/{block_trade_proposal_id}/accept | Accept Block Trade Proposal|
 |[**acceptQuote**](#acceptquote) | **PUT** /communications/quotes/{quote_id}/accept | Accept Quote|
+|[**acceptRFQQuote**](#acceptrfqquote) | **PUT** /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept | Accept RFQ Quote|
 |[**confirmQuote**](#confirmquote) | **PUT** /communications/quotes/{quote_id}/confirm | Confirm Quote|
+|[**confirmRFQQuote**](#confirmrfqquote) | **PUT** /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm | Confirm RFQ 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|
+|[**deleteRFQQuote**](#deleterfqquote) | **DELETE** /communications/rfqs/{rfq_id}/quotes/{quote_id} | Delete RFQ Quote|
 |[**getBlockTradeProposals**](#getblocktradeproposals) | **GET** /communications/block-trade-proposals | Get Block Trade Proposals|
 |[**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|
+|[**getRFQQuote**](#getrfqquote) | **GET** /communications/rfqs/{rfq_id}/quotes/{quote_id} | Get RFQ Quote|
 |[**getRFQs**](#getrfqs) | **GET** /communications/rfqs | Get RFQs|
 |[**proposeBlockTrade**](#proposeblocktrade) | **POST** /communications/block-trade-proposals | Propose Block Trade|
 
@@ -58,7 +62,7 @@ void (empty response body)
 # **acceptQuote**
 > acceptQuote(acceptQuoteRequest)
 
- Endpoint for accepting a quote. This will require the quoter to confirm
+DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept instead. Endpoint for accepting a quote. This will require the quoter to confirm.
 
 ### Parameters
 
@@ -68,6 +72,43 @@ void (empty response body)
 | **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 |  -  |
+
+# **acceptRFQQuote**
+> acceptRFQQuote(acceptQuoteRequest)
+
+ Endpoint for accepting a quote scoped to its RFQ. This will require the quoter to confirm.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptQuoteRequest** | **AcceptQuoteRequest**|  | |
+| **rfqId** | [**string**] | RFQ ID | defaults to undefined|
+| **quoteId** | [**string**] | Quote ID | defaults to undefined|
+
+
 ### Return type
 
 void (empty response body)
@@ -94,7 +135,7 @@ void (empty response body)
 # **confirmQuote**
 > confirmQuote()
 
- Endpoint for confirming a quote. This will start a timer for order execution
+DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm instead. Endpoint for confirming a quote. This will start a timer for order execution.
 
 ### Parameters
 
@@ -104,6 +145,42 @@ void (empty response body)
 | **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 |  -  |
+
+# **confirmRFQQuote**
+> confirmRFQQuote()
+
+ Endpoint for confirming a quote scoped to its RFQ. This will start a timer for order execution.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+| **rfqId** | [**string**] | RFQ ID | defaults to undefined|
+| **quoteId** | [**string**] | Quote ID | defaults to undefined|
+
+
 ### Return type
 
 void (empty response body)
@@ -198,7 +275,7 @@ void (empty response body)
 # **deleteQuote**
 > deleteQuote()
 
- Endpoint for deleting a quote, which means it can no longer be accepted.
+DEPRECATED: Use DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for deleting a quote, which means it can no longer be accepted.
 
 ### Parameters
 
@@ -263,6 +340,41 @@ void (empty response body)
 |**404** | Resource not found |  -  |
 |**500** | Internal server error |  -  |
 
+# **deleteRFQQuote**
+> deleteRFQQuote()
+
+ Endpoint for deleting a quote scoped to its RFQ, which means it can no longer be accepted.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rfqId** | [**string**] | RFQ ID | defaults to undefined|
+| **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 |  -  |
+
 # **getBlockTradeProposals**
 > GetBlockTradeProposalsResponse getBlockTradeProposals()
 
@@ -333,7 +445,7 @@ This endpoint does not have any parameters.
 # **getQuote**
 > GetQuoteResponse getQuote()
 
- Endpoint for getting a particular quote
+DEPRECATED: Use GET /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for getting a particular quote.
 
 ### Parameters
 
@@ -441,6 +553,41 @@ This endpoint does not have any parameters.
 |**404** | Resource not found |  -  |
 |**500** | Internal server error |  -  |
 
+# **getRFQQuote**
+> GetQuoteResponse getRFQQuote()
+
+ Endpoint for getting a particular quote scoped to its RFQ.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rfqId** | [**string**] | RFQ ID | defaults to undefined|
+| **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 |  -  |
+
 # **getRFQs**
 > GetRFQsResponse getRFQs()
 

package/docs/CreateApiKeyRequest.md

@@ -8,6 +8,7 @@ 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<ApiKeyScope>**](ApiKeyScope.md) | List of scopes to grant to the API key. If the broad `write` parent scope is included, `read` must also be included. Child scopes may be granted without the broad parent scope. Defaults to full access (`read`, `write`) if not provided. | [optional] [default to undefined]
+**subaccount** | **number** | If set, restricts the API key to a single sub-account (0-63) that you own. A restricted key may only read and trade on that sub-account; it cannot act on other sub-accounts, transfer funds between sub-accounts, or create sub-accounts. Omit to leave the key unrestricted. | [optional] [default to undefined]
 
 ## Example
 
@@ -18,6 +19,7 @@ const instance: CreateApiKeyRequest = {
     name,
     public_key,
     scopes,
+    subaccount,
 };
 ```
 

package/docs/CreateOrderGroupRequest.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **subaccount** | **number** | Optional subaccount number to use for this order group (0 for primary, 1-63 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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. 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]
+**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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [optional] [default to undefined]
 **exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [optional] [default to undefined]
 
 ## Example

package/docs/CreateOrderRequest.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **side** | **string** |  | [default to undefined]
 **action** | **string** |  | [default to undefined]
 **count** | **number** | Order quantity in contracts (whole contracts only). 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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. 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]
+**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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [optional] [default to undefined]
 **yes_price** | **number** |  | [optional] [default to undefined]
 **no_price** | **number** |  | [optional] [default to undefined]
 **yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]

package/docs/CreateOrderV2Request.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **ticker** | **string** |  | [default to undefined]
 **client_order_id** | **string** |  | [optional] [default to undefined]
 **side** | [**BookSide**](BookSide.md) |  | [default to undefined]
-**count** | **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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**count** | **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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 **price** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **expiration_time** | **number** | Optional Unix timestamp in seconds for when the order expires. To place an expiring order, set `time_in_force` to `good_till_canceled` and provide this `expiration_time`. `GTT` is an internal execution type and is not a valid API value for `time_in_force`. The `immediate_or_cancel` time-in-force value cannot be combined with `expiration_time`.  | [optional] [default to undefined]
 **time_in_force** | **string** | Specifies how long the order remains active. Use `good_till_canceled` with `expiration_time` for an order that should rest until a specific expiration time; without `expiration_time`, `good_till_canceled` is a true good-till-canceled order. `GTT` is not a valid API value.  | [default to undefined]

package/docs/CreateOrderV2Response.md

@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order_id** | **string** |  | [default to undefined]
 **client_order_id** | **string** |  | [optional] [default to undefined]
-**fill_count** | **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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
-**remaining_count** | **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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**fill_count** | **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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
+**remaining_count** | **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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 **average_fill_price** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **average_fee_paid** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **ts_ms** | **number** | Matching engine timestamp at which the order was processed, as Unix epoch milliseconds. | [default to undefined]

package/docs/CreateRFQRequest.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **market_ticker** | **string** | The ticker of the market for which to create an RFQ | [default to undefined]
 **contracts** | **number** | Whole-contract count for the RFQ. Use contracts_fp for partial contract values; if both are provided, they must match. | [optional] [default to undefined]
-**contracts_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. 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]
+**contracts_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [optional] [default to undefined]
 **target_cost_centi_cents** | **number** | DEPRECATED: The target cost for the RFQ in centi-cents. Use target_cost_dollars instead. | [optional] [default to undefined]
 **target_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **rest_remainder** | **boolean** | Whether to rest the remainder of the RFQ after execution | [default to undefined]

package/docs/CreateSubaccountRequest.md

@@ -0,0 +1,20 @@
+# CreateSubaccountRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateSubaccountRequest } from 'kalshi-typescript';
+
+const instance: CreateSubaccountRequest = {
+    exchange_index,
+};
+```
+
+[[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/DecreaseOrderV2Request.md

@@ -5,8 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**reduce_by** | **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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. 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]
-**reduce_to** | **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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. 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]
+**reduce_by** | **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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [optional] [default to undefined]
+**reduce_to** | **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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [optional] [default to undefined]
 **exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [optional] [default to undefined]
 
 ## Example

package/docs/DecreaseOrderV2Response.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order_id** | **string** |  | [default to undefined]
 **client_order_id** | **string** |  | [optional] [default to undefined]
-**remaining_count** | **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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**remaining_count** | **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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 **ts_ms** | **number** | Matching engine timestamp at which the decrease was processed, as Unix epoch milliseconds. | [default to undefined]
 
 ## Example

package/docs/EventPosition.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **event_ticker** | **string** | Unique identifier for events | [default to undefined]
 **total_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
-**total_cost_shares_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**total_cost_shares_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 **event_exposure_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **realized_pnl_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **fees_paid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]

package/docs/ExchangeApi.md

@@ -4,41 +4,11 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getExchangeAnnouncements**](#getexchangeannouncements) | **GET** /exchange/announcements | Get Exchange Announcements|
 |[**getExchangeSchedule**](#getexchangeschedule) | **GET** /exchange/schedule | Get Exchange Schedule|
 |[**getExchangeStatus**](#getexchangestatus) | **GET** /exchange/status | Get Exchange Status|
 |[**getSeriesFeeChanges**](#getseriesfeechanges) | **GET** /series/fee_changes | Get Series Fee Changes|
 |[**getUserDataTimestamp**](#getuserdatatimestamp) | **GET** /exchange/user_data_timestamp | Get User Data Timestamp|
 
-# **getExchangeAnnouncements**
-> GetExchangeAnnouncementsResponse getExchangeAnnouncements()
-
- Endpoint for getting all exchange-wide announcements.
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**GetExchangeAnnouncementsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Exchange announcements retrieved successfully |  -  |
-|**500** | Internal server error |  -  |
-
 # **getExchangeSchedule**
 > GetExchangeScheduleResponse getExchangeSchedule()
 

package/docs/ExchangeIndexStatus.md

@@ -0,0 +1,26 @@
+# ExchangeIndexStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [default to undefined]
+**exchange_active** | **boolean** | False if this exchange index is no longer taking any state changes at all. True unless under maintenance. | [default to undefined]
+**trading_active** | **boolean** | True if trading is currently permitted on this exchange index. False outside exchange hours or during pauses. | [default to undefined]
+**intra_exchange_transfers_active** | **boolean** | True if intra-exchange transfers are currently permitted on this exchange index. False when transfers are temporarily blocked. | [default to undefined]
+
+## Example
+
+```typescript
+import { ExchangeIndexStatus } from 'kalshi-typescript';
+
+const instance: ExchangeIndexStatus = {
+    exchange_index,
+    exchange_active,
+    trading_active,
+    intra_exchange_transfers_active,
+};
+```
+
+[[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/ExchangeStatus.md

@@ -7,7 +7,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **exchange_active** | **boolean** | False if the core Kalshi exchange is no longer taking any state changes at all. This includes but is not limited to trading, new users, and transfers. True unless we are under maintenance. | [default to undefined]
 **trading_active** | **boolean** | True if we are currently permitting trading on the exchange. This is true during trading hours and false outside exchange hours. Kalshi reserves the right to pause at any time in case issues are detected. | [default to undefined]
+**intra_exchange_transfers_active** | **boolean** | True if intra-exchange transfers are currently permitted. False when transfers are temporarily blocked. | [optional] [default to undefined]
 **exchange_estimated_resume_time** | **string** | Estimated downtime for the current exchange maintenance window. However, this is not guaranteed and can be extended. | [optional] [default to undefined]
+**exchange_index_statuses** | [**Array<ExchangeIndexStatus>**](ExchangeIndexStatus.md) | Status of each exchange index. The top-level fields above reflect the default exchange index (0). Absent when the per-index breakdown is unavailable. | [optional] [default to undefined]
 
 ## Example
 
@@ -17,7 +19,9 @@ import { ExchangeStatus } from 'kalshi-typescript';
 const instance: ExchangeStatus = {
     exchange_active,
     trading_active,
+    intra_exchange_transfers_active,
     exchange_estimated_resume_time,
+    exchange_index_statuses,
 };
 ```
 

package/docs/Fill.md

@@ -10,11 +10,11 @@ Name | Type | Description | Notes
 **order_id** | **string** | Unique identifier for the order that resulted in this fill | [default to undefined]
 **ticker** | **string** | Unique identifier for the market | [default to undefined]
 **market_ticker** | **string** | Unique identifier for the market (legacy field name, same as ticker) | [default to undefined]
-**side** | **string** | Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.  | [default to undefined]
-**action** | **string** | Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.  | [default to undefined]
+**side** | **string** | Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.  | [optional] [default to undefined]
+**action** | **string** | Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.  | [optional] [default to undefined]
 **outcome_side** | **string** | The outcome side this fill positioned the user for. buy-yes and sell-no produce \'yes\'; buy-no and sell-yes produce \'no\'.  `outcome_side` describes directional exposure only; it does not change the fill\'s price. A fill at price `p` with `outcome_side=no` is matched against an order at the same price `p` with `outcome_side=yes` — both parties trade at the same price, just on opposite directions.  `outcome_side` and `book_side` will become the canonical way to determine fill direction. The legacy `action` and `side` fields will be deprecated in a future release — please migrate to these new fields.  | [default to undefined]
 **book_side** | [**BookSide**](BookSide.md) |  | [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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 **yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **is_taker** | **boolean** | If true, this fill was a taker (removed liquidity from the order book) | [default to undefined]

package/docs/GenerateApiKeyRequest.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **string** | Name for the API key. This helps identify the key\'s purpose | [default to undefined]
 **scopes** | [**Array<ApiKeyScope>**](ApiKeyScope.md) | List of scopes to grant to the API key. If the broad `write` parent scope is included, `read` must also be included. Child scopes may be granted without the broad parent scope. Defaults to full access (`read`, `write`) if not provided. | [optional] [default to undefined]
+**subaccount** | **number** | If set, restricts the API key to a single sub-account (0-63) that you own. A restricted key may only read and trade on that sub-account; it cannot act on other sub-accounts, transfer funds between sub-accounts, or create sub-accounts. Omit to leave the key unrestricted. | [optional] [default to undefined]
 
 ## Example
 
@@ -16,6 +17,7 @@ import { GenerateApiKeyRequest } from 'kalshi-typescript';
 const instance: GenerateApiKeyRequest = {
     name,
     scopes,
+    subaccount,
 };
 ```
 

package/docs/GetOrderGroupResponse.md

@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. 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]
+**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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [optional] [default to undefined]
 **orders** | **Array<string>** | List of order IDs that belong to this order group | [default to undefined]
 **exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [optional] [default to undefined]
 

package/docs/GetOrderQueuePositionResponse.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 
 ## Example
 

package/docs/IncentiveProgram.md

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **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_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. 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]
+**target_size_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Market.md

@@ -21,25 +21,23 @@ Name | Type | Description | Notes
 **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** | The current status of the market in its lifecycle. | [default to undefined]
-**response_price_units** | **string** | DEPRECATED: Use price_level_structure and price_ranges instead. | [optional] [default to undefined]
 **yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
-**yes_bid_size_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**yes_bid_size_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 **yes_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
-**yes_ask_size_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**yes_ask_size_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 **no_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **no_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **last_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
-**volume_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
-**volume_24h_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**volume_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
+**volume_24h_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 **result** | **string** |  | [default to undefined]
 **can_close_early** | **boolean** |  | [default to undefined]
-**fractional_trading_enabled** | **boolean** | Deprecated. This flag is always `true` and carries no information. Will be removed after a pre-announcement with the removal date. | [default to undefined]
-**open_interest_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**open_interest_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 **notional_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **previous_yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **previous_yes_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **previous_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
-**liquidity_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
+**liquidity_dollars** | **string** | DEPRECATED: This field is deprecated and will always return \"0.0000\". | [optional] [default to undefined]
 **settlement_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 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]
 **settlement_ts** | **string** | Timestamp when the market was settled. Only filled for settled markets | [optional] [default to undefined]
 **expiration_value** | **string** | The value that was considered for the settlement | [default to undefined]
@@ -83,7 +81,6 @@ const instance: Market = {
     latest_expiration_time,
     settlement_timer_seconds,
     status,
-    response_price_units,
     yes_bid_dollars,
     yes_bid_size_fp,
     yes_ask_dollars,
@@ -95,7 +92,6 @@ const instance: Market = {
     volume_24h_fp,
     result,
     can_close_early,
-    fractional_trading_enabled,
     open_interest_fp,
     notional_value_dollars,
     previous_yes_bid_dollars,

package/docs/MarketCandlestick.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **yes_bid** | [**BidAskDistribution**](BidAskDistribution.md) |  | [default to undefined]
 **yes_ask** | [**BidAskDistribution**](BidAskDistribution.md) |  | [default to undefined]
 **price** | [**PriceDistribution**](PriceDistribution.md) |  | [default to undefined]
-**volume_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
-**open_interest_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. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**volume_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
+**open_interest_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. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts. | [default to undefined]
 
 ## Example