kalshi-typescript 3.20.0 → 3.22.0

package/docs/GenerateApiKeyRequest.md

@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **string** | Name for the API key. This helps identify the key\'s purpose | [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]
+**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]
 
 ## Example
 

package/docs/GetAccountApiLimitsResponse.md

@@ -5,9 +5,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**usage_tier** | **string** | User\'s API usage tier. | [default to undefined]
+**usage_tier** | **string** | User\'s effective Predictions API usage tier for these limits (for example, basic, advanced, expert, premier, paragon, prime, or prestige). | [default to undefined]
 **read** | [**BucketLimit**](BucketLimit.md) |  | [default to undefined]
 **write** | [**BucketLimit**](BucketLimit.md) |  | [default to undefined]
+**grants** | [**Array<ApiUsageLevelGrant>**](ApiUsageLevelGrant.md) | The caller\'s active API usage level grants across exchange lanes, where each grant applies to its exchange_instance and usage_tier reflects the effective tier for the lane reported by this endpoint. | [default to undefined]
 
 ## Example
 
@@ -18,6 +19,7 @@ const instance: GetAccountApiLimitsResponse = {
     usage_tier,
     read,
     write,
+    grants,
 };
 ```
 

package/docs/GetAccountApiUsageLevelVolumeProgressResponse.md

@@ -0,0 +1,20 @@
+# GetAccountApiUsageLevelVolumeProgressResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**volume_progress** | [**Array<AccountApiUsageLevelVolumeProgress>**](AccountApiUsageLevelVolumeProgress.md) | Latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume-based public tiers are Expert, Premier, Paragon, Prime, and Prestige. | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAccountApiUsageLevelVolumeProgressResponse } from 'kalshi-typescript';
+
+const instance: GetAccountApiUsageLevelVolumeProgressResponse = {
+    volume_progress,
+};
+```
+
+[[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/GetBlockTradeProposalsResponse.md

@@ -0,0 +1,22 @@
+# GetBlockTradeProposalsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**block_trade_proposals** | [**Array<BlockTradeProposal>**](BlockTradeProposal.md) | List of block trade proposals | [default to undefined]
+**cursor** | **string** | Cursor for pagination to get the next page of results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetBlockTradeProposalsResponse } from 'kalshi-typescript';
+
+const instance: GetBlockTradeProposalsResponse = {
+    block_trade_proposals,
+    cursor,
+};
+```
+
+[[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/MarketApi.md

@@ -197,7 +197,7 @@ Endpoint for getting the current order books for multiple markets in a single re
 # **getMarkets**
 > GetMarketsResponse getMarkets()
 
-Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details. 
+Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.  - Only one `status` filter may be supplied at a time.  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.   | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |  |------------------------------|--------------------------|-------------|  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |  | min_close_ts, max_close_ts | `closed`, *empty* | |  | min_settled_ts, max_settled_ts | `settled`, *empty* | |  | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude`. May be combined with `series_ticker`, which requires `mve_filter=exclude` |   Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details. 
 
 ### Parameters
 
@@ -209,7 +209,7 @@ Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled
 | **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
 | **minCreatedTs** | [**number**] | Filter items that created after this Unix timestamp | (optional) defaults to undefined|
 | **maxCreatedTs** | [**number**] | Filter items that created before this Unix timestamp | (optional) defaults to undefined|
-| **minUpdatedTs** | [**number**] | Return markets with metadata updated later than this Unix timestamp. Tracks non-trading changes only. Incompatible with any other filters. | (optional) defaults to undefined|
+| **minUpdatedTs** | [**number**] | Return markets with metadata updated later than this Unix timestamp. Tracks non-trading changes only. Incompatible with any other filters except mve_filter=exclude. May be combined with series_ticker, which requires mve_filter=exclude. | (optional) defaults to undefined|
 | **maxCloseTs** | [**number**] | Filter items that close before this Unix timestamp | (optional) defaults to undefined|
 | **minCloseTs** | [**number**] | Filter items that close after this Unix timestamp | (optional) defaults to undefined|
 | **minSettledTs** | [**number**] | Filter items that settled after this Unix timestamp | (optional) defaults to undefined|

package/docs/MultivariateApi.md

@@ -43,7 +43,7 @@ Endpoint for creating an individual market in a multivariate event collection. T
 |**200** | Market created successfully |  -  |
 |**400** | Bad request - invalid input |  -  |
 |**401** | Unauthorized - authentication required |  -  |
-|**429** | Rate limit exceeded. The default cost is 10 tokens per request; endpoints that deviate show a **Rate limit** callout at the top of their own page. See [Rate Limits and Tiers](/getting_started/rate_limits). |  -  |
+|**429** | Rate limit exceeded. The default cost is 10 tokens per request. Use GET /trade-api/v2/account/endpoint_costs to list non-default endpoint costs. |  -  |
 |**500** | Internal server error |  -  |
 
 # **getMultivariateEventCollection**

package/docs/Order.md

@@ -30,7 +30,7 @@ Name | Type | Description | Notes
 **self_trade_prevention_type** | [**SelfTradePreventionType**](SelfTradePreventionType.md) |  | [optional] [default to undefined]
 **order_group_id** | **string** | The order group this order is part of | [optional] [default to undefined]
 **cancel_order_on_pause** | **boolean** | If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason. | [optional] [default to undefined]
-**subaccount_number** | **number** | Subaccount number (0 for primary, 1-32 for subaccounts). | [optional] [default to undefined]
+**subaccount_number** | **number** | Subaccount number (0 for primary, 1-63 for subaccounts). | [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/OrderGroupsApi.md

@@ -56,7 +56,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
 | **exchangeIndex** | [**number**] |  | (optional) defaults to undefined|
 
 
@@ -92,7 +92,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -126,7 +126,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -162,7 +162,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
 |------------- | ------------- | ------------- | -------------|
 | **body** | **object**|  | |
 | **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
 | **exchangeIndex** | [**number**] |  | (optional) defaults to undefined|
 
 
@@ -199,7 +199,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
 |------------- | ------------- | ------------- | -------------|
 | **body** | **object**|  | |
 | **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
 | **exchangeIndex** | [**number**] |  | (optional) defaults to undefined|
 
 

package/docs/OrdersApi.md

@@ -4,59 +4,17 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**amendOrder**](#amendorder) | **POST** /portfolio/orders/{order_id}/amend | Amend Order|
 |[**amendOrderV2**](#amendorderv2) | **POST** /portfolio/events/orders/{order_id}/amend | Amend Order (V2)|
-|[**batchCancelOrders**](#batchcancelorders) | **DELETE** /portfolio/orders/batched | Batch Cancel Orders|
 |[**batchCancelOrdersV2**](#batchcancelordersv2) | **DELETE** /portfolio/events/orders/batched | Batch Cancel Orders (V2)|
-|[**batchCreateOrders**](#batchcreateorders) | **POST** /portfolio/orders/batched | Batch Create Orders|
 |[**batchCreateOrdersV2**](#batchcreateordersv2) | **POST** /portfolio/events/orders/batched | Batch Create Orders (V2)|
-|[**cancelOrder**](#cancelorder) | **DELETE** /portfolio/orders/{order_id} | Cancel Order|
 |[**cancelOrderV2**](#cancelorderv2) | **DELETE** /portfolio/events/orders/{order_id} | Cancel Order (V2)|
-|[**createOrder**](#createorder) | **POST** /portfolio/orders | Create Order|
 |[**createOrderV2**](#createorderv2) | **POST** /portfolio/events/orders | Create Order (V2)|
-|[**decreaseOrder**](#decreaseorder) | **POST** /portfolio/orders/{order_id}/decrease | Decrease Order|
 |[**decreaseOrderV2**](#decreaseorderv2) | **POST** /portfolio/events/orders/{order_id}/decrease | Decrease Order (V2)|
 |[**getOrder**](#getorder) | **GET** /portfolio/orders/{order_id} | Get Order|
 |[**getOrderQueuePosition**](#getorderqueueposition) | **GET** /portfolio/orders/{order_id}/queue_position | Get Order Queue Position|
 |[**getOrderQueuePositions**](#getorderqueuepositions) | **GET** /portfolio/orders/queue_positions | Get Queue Positions for Orders|
 |[**getOrders**](#getorders) | **GET** /portfolio/orders | Get Orders|
 
-# **amendOrder**
-> AmendOrderResponse amendOrder(amendOrderRequest)
-
- Endpoint for amending the max number of fillable contracts and/or price in an existing order. Max fillable contracts is `remaining_count` + `fill_count`.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **amendOrderRequest** | **AmendOrderRequest**|  | |
-| **orderId** | [**string**] | Order ID | defaults to undefined|
-
-
-### Return type
-
-**AmendOrderResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order amended successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
-|**500** | Internal server error |  -  |
-
 # **amendOrderV2**
 > AmendOrderV2Response amendOrderV2(amendOrderV2Request)
 
@@ -68,7 +26,7 @@ Endpoint for amending the price and/or max fillable count of an existing event-m
 |------------- | ------------- | ------------- | -------------|
 | **amendOrderV2Request** | **AmendOrderV2Request**|  | |
 | **orderId** | [**string**] | Order ID | defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -94,41 +52,6 @@ Endpoint for amending the price and/or max fillable count of an existing event-m
 |**404** | Resource not found |  -  |
 |**500** | Internal server error |  -  |
 
-# **batchCancelOrders**
-> BatchCancelOrdersResponse batchCancelOrders(batchCancelOrdersRequest)
-
-Endpoint for cancelling a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **batchCancelOrdersRequest** | **BatchCancelOrdersRequest**|  | |
-
-
-### Return type
-
-**BatchCancelOrdersResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Batch order cancellation completed |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**403** | Forbidden - insufficient permissions |  -  |
-|**500** | Internal server error |  -  |
-
 # **batchCancelOrdersV2**
 > BatchCancelOrdersV2Response batchCancelOrdersV2(batchCancelOrdersV2Request)
 
@@ -164,41 +87,6 @@ Endpoint for cancelling a batch of event-market orders using the V2 response sha
 |**403** | Forbidden - insufficient permissions |  -  |
 |**500** | Internal server error |  -  |
 
-# **batchCreateOrders**
-> BatchCreateOrdersResponse batchCreateOrders(batchCreateOrdersRequest)
-
-Endpoint for submitting a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **batchCreateOrdersRequest** | **BatchCreateOrdersRequest**|  | |
-
-
-### Return type
-
-**BatchCreateOrdersResponse**
-
-### 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** | Batch order creation completed |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**403** | Forbidden - insufficient permissions |  -  |
-|**500** | Internal server error |  -  |
-
 # **batchCreateOrdersV2**
 > BatchCreateOrdersV2Response batchCreateOrdersV2(batchCreateOrdersV2Request)
 
@@ -234,42 +122,6 @@ Endpoint for submitting a batch of event-market orders using the V2 request/resp
 |**403** | Forbidden - insufficient permissions |  -  |
 |**500** | Internal server error |  -  |
 
-# **cancelOrder**
-> CancelOrderResponse cancelOrder()
-
- Endpoint for canceling orders. The value for the orderId should match the id field of the order you want to decrease. Commonly, DELETE-type endpoints return 204 status with no body content on success. But we can\'t completely delete the order, as it may be partially filled already. Instead, the DeleteOrder endpoint reduce the order completely, essentially zeroing the remaining resting contracts on it. The zeroed order is returned on the response payload as a form of validation for the client.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **orderId** | [**string**] | Order ID | defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
-| **exchangeIndex** | [**number**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**CancelOrderResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order cancelled successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
-|**500** | Internal server error |  -  |
-
 # **cancelOrderV2**
 > CancelOrderV2Response cancelOrderV2()
 
@@ -280,8 +132,9 @@ Endpoint for cancelling event-market orders using the V2 response shape. Returns
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **orderId** | [**string**] | Order ID | defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
 | **exchangeIndex** | [**number**] |  | (optional) defaults to undefined|
+| **marketTicker** | [**string**] | Market ticker. Required when exchange_index is -1 (auto). | (optional) defaults to undefined|
 
 
 ### Return type
@@ -306,42 +159,6 @@ Endpoint for cancelling event-market orders using the V2 response shape. Returns
 |**404** | Resource not found |  -  |
 |**500** | Internal server error |  -  |
 
-# **createOrder**
-> CreateOrderResponse createOrder(createOrderRequest)
-
- Endpoint for submitting orders in a market. Each user is limited to 200 000 open orders at a time.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createOrderRequest** | **CreateOrderRequest**|  | |
-
-
-### Return type
-
-**CreateOrderResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | Order created successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**409** | Conflict - resource already exists or cannot be modified |  -  |
-|**429** | Rate limit exceeded. The default cost is 10 tokens per request; endpoints that deviate show a **Rate limit** callout at the top of their own page. See [Rate Limits and Tiers](/getting_started/rate_limits). |  -  |
-|**500** | Internal server error |  -  |
-
 # **createOrderV2**
 > CreateOrderV2Response createOrderV2(createOrderV2Request)
 
@@ -375,43 +192,7 @@ Endpoint for submitting event-market orders using the V2 request/response shape
 |**400** | Bad request - invalid input |  -  |
 |**401** | Unauthorized - authentication required |  -  |
 |**409** | Conflict - resource already exists or cannot be modified |  -  |
-|**429** | Rate limit exceeded. The default cost is 10 tokens per request; endpoints that deviate show a **Rate limit** callout at the top of their own page. See [Rate Limits and Tiers](/getting_started/rate_limits). |  -  |
-|**500** | Internal server error |  -  |
-
-# **decreaseOrder**
-> DecreaseOrderResponse decreaseOrder(decreaseOrderRequest)
-
- Endpoint for decreasing the number of contracts in an existing order. This is the only kind of edit available on order quantity. Cancelling an order is equivalent to decreasing an order amount to zero.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **decreaseOrderRequest** | **DecreaseOrderRequest**|  | |
-| **orderId** | [**string**] | Order ID | defaults to undefined|
-
-
-### Return type
-
-**DecreaseOrderResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order decreased successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
+|**429** | Rate limit exceeded. The default cost is 10 tokens per request. Use GET /trade-api/v2/account/endpoint_costs to list non-default endpoint costs. |  -  |
 |**500** | Internal server error |  -  |
 
 # **decreaseOrderV2**
@@ -425,7 +206,7 @@ Endpoint for decreasing the remaining count of an existing event-market order us
 |------------- | ------------- | ------------- | -------------|
 | **decreaseOrderV2Request** | **DecreaseOrderV2Request**|  | |
 | **orderId** | [**string**] | Order ID | defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -530,7 +311,7 @@ Endpoint for decreasing the remaining count of an existing event-market order us
 |------------- | ------------- | ------------- | -------------|
 | **marketTickers** | [**string**] | Comma-separated list of market tickers to filter by | (optional) defaults to undefined|
 | **eventTicker** | [**string**] | Event ticker to filter by | (optional) defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -571,7 +352,7 @@ Restricts the response to orders that have a certain status: resting, canceled,
 | **status** | [**string**] | Filter by status. Possible values depend on the endpoint. | (optional) defaults to undefined|
 | **limit** | [**number**] | Number of results per page. Defaults to 100. | (optional) defaults to 100|
 | **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|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/PortfolioApi.md

@@ -21,7 +21,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
 # **applySubaccountTransfer**
 > object applySubaccountTransfer(applySubaccountTransferRequest)
 
-Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts.
 
 ### Parameters
 
@@ -55,7 +55,7 @@ Transfers funds between the authenticated user\'s subaccounts. Use 0 for the pri
 # **createSubaccount**
 > CreateSubaccountResponse createSubaccount()
 
-Creates a new subaccount for the authenticated user. This endpoint is currently only available to institutions and market makers. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user.
+Creates a new subaccount for the authenticated user. This endpoint is currently only available to institutions and market makers. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).
 
 ### Parameters
 This endpoint does not have any parameters.
@@ -86,13 +86,13 @@ This endpoint does not have any parameters.
 # **getBalance**
 > GetBalanceResponse getBalance()
 
- Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
+Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents. This endpoint also accepts API keys with the \'read::portfolio_balance\' scope.
 
 ### Parameters
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -166,7 +166,7 @@ Endpoint for getting all fills for the member. A fill is when a trade you have i
 | **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
 | **limit** | [**number**] | Number of results per page. Defaults to 100. | (optional) defaults to 100|
 | **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|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -235,7 +235,7 @@ Restricts the positions to those with any of following fields with non-zero valu
 | **countFilter** | [**string**] | Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded | (optional) defaults to undefined|
 | **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
 | **eventTicker** | [**string**] | Event ticker to filter by. Only a single event ticker is supported. | (optional) defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -275,7 +275,7 @@ Restricts the positions to those with any of following fields with non-zero valu
 | **eventTicker** | [**string**] | Event ticker to filter by. Only a single event ticker is supported. | (optional) defaults to undefined|
 | **minTs** | [**number**] | Filter items after this Unix timestamp | (optional) defaults to undefined|
 | **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
-| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -432,7 +432,7 @@ Endpoint for getting the member\'s withdrawal history.
 # **updateSubaccountNetting**
 > updateSubaccountNetting(updateSubaccountNettingRequest)
 
-Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.
 
 ### Parameters
 

package/docs/ProposeBlockTradeRequest.md

@@ -0,0 +1,40 @@
+# ProposeBlockTradeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buyer_user_id** | **string** | User ID of the buyer | [default to undefined]
+**buyer_subtrader_id** | **string** | Subtrader ID of the buyer. Provide either this or buyer_subaccount, not both. | [optional] [default to undefined]
+**buyer_subaccount** | **number** | User-managed subaccount number of the buyer (0 for primary, 1-63 for numbered subaccounts). Provide either this or buyer_subtrader_id, not both. | [optional] [default to undefined]
+**seller_user_id** | **string** | User ID of the seller | [default to undefined]
+**seller_subtrader_id** | **string** | Subtrader ID of the seller. Provide either this or seller_subaccount, not both. | [optional] [default to undefined]
+**seller_subaccount** | **number** | User-managed subaccount number of the seller (0 for primary, 1-63 for numbered subaccounts). Provide either this or seller_subtrader_id, not both. | [optional] [default to undefined]
+**market_ticker** | **string** | The ticker of the market for this block trade | [default to undefined]
+**price_centi_cents** | **number** | Price in centi-cents | [default to undefined]
+**centicount** | **number** | Number of contracts in centicounts | [default to undefined]
+**maker_side** | **string** | The maker side of the trade | [default to undefined]
+**expiration_ts** | **string** | Expiration time of the proposal | [default to undefined]
+
+## Example
+
+```typescript
+import { ProposeBlockTradeRequest } from 'kalshi-typescript';
+
+const instance: ProposeBlockTradeRequest = {
+    buyer_user_id,
+    buyer_subtrader_id,
+    buyer_subaccount,
+    seller_user_id,
+    seller_subtrader_id,
+    seller_subaccount,
+    market_ticker,
+    price_centi_cents,
+    centicount,
+    maker_side,
+    expiration_ts,
+};
+```
+
+[[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/{DecreaseOrderResponse.md → ProposeBlockTradeResponse.md}

@@ -1,19 +1,19 @@
-# DecreaseOrderResponse
+# ProposeBlockTradeResponse
 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**order** | [**Order**](Order.md) |  | [default to undefined]
+**block_trade_proposal_id** | **string** | The ID of the newly created block trade proposal | [default to undefined]
 
 ## Example
 
 ```typescript
-import { DecreaseOrderResponse } from 'kalshi-typescript';
+import { ProposeBlockTradeResponse } from 'kalshi-typescript';
 
-const instance: DecreaseOrderResponse = {
-    order,
+const instance: ProposeBlockTradeResponse = {
+    block_trade_proposal_id,
 };
 ```
 

package/docs/Settlement.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ticker** | **string** | The ticker symbol of the market that was settled. | [default to undefined]
 **event_ticker** | **string** | The event ticker symbol of the market that was settled. | [default to undefined]
-**market_result** | **string** | The outcome of the market settlement. \'yes\' = market resolved to YES, \'no\' = market resolved to NO, \'scalar\' = scalar market settled at a specific value, \'void\' = market was voided/cancelled and all positions returned at original cost. | [default to undefined]
+**market_result** | **string** | The outcome of the market settlement. \'yes\' = market resolved to YES, \'no\' = market resolved to NO, \'scalar\' = scalar market settled at a specific value. | [default to undefined]
 **yes_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]
 **yes_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]
 **no_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]

package/docs/SubaccountBalance.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subaccount_number** | **number** | Subaccount number (0 for primary, 1-32 for subaccounts). | [default to undefined]
+**subaccount_number** | **number** | Subaccount number (0 for primary, 1-63 for subaccounts). | [default to undefined]
 **balance** | **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]
 **updated_ts** | **number** | Unix timestamp of last balance update. | [default to undefined]
 

package/docs/SubaccountNettingConfig.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subaccount_number** | **number** | Subaccount number (0 for primary, 1-32 for subaccounts). | [default to undefined]
+**subaccount_number** | **number** | Subaccount number (0 for primary, 1-63 for subaccounts). | [default to undefined]
 **enabled** | **boolean** | Whether netting is enabled for this subaccount. | [default to undefined]
 
 ## Example