kalshi-typescript 3.5.0 → 3.7.0

package/docs/PortfolioApi.md

@@ -0,0 +1,324 @@
+# PortfolioApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**applySubaccountTransfer**](#applysubaccounttransfer) | **POST** /portfolio/subaccounts/transfer | Transfer Between Subaccounts|
+|[**createSubaccount**](#createsubaccount) | **POST** /portfolio/subaccounts | Create Subaccount|
+|[**getBalance**](#getbalance) | **GET** /portfolio/balance | Get Balance|
+|[**getFills**](#getfills) | **GET** /portfolio/fills | Get Fills|
+|[**getPortfolioRestingOrderTotalValue**](#getportfoliorestingordertotalvalue) | **GET** /portfolio/summary/total_resting_order_value | Get Total Resting Order Value|
+|[**getPositions**](#getpositions) | **GET** /portfolio/positions | Get Positions|
+|[**getSettlements**](#getsettlements) | **GET** /portfolio/settlements | Get Settlements|
+|[**getSubaccountBalances**](#getsubaccountbalances) | **GET** /portfolio/subaccounts/balances | Get All Subaccount Balances|
+|[**getSubaccountTransfers**](#getsubaccounttransfers) | **GET** /portfolio/subaccounts/transfers | Get Subaccount Transfers|
+
+# **applySubaccountTransfer**
+> object applySubaccountTransfer(applySubaccountTransferRequest)
+
+Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **applySubaccountTransferRequest** | **ApplySubaccountTransferRequest**|  | |
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Transfer completed successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **createSubaccount**
+> CreateSubaccountResponse createSubaccount()
+
+Creates a new subaccount for the authenticated user. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**CreateSubaccountResponse**
+
+### 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 |
+|-------------|-------------|------------------|
+|**201** | Subaccount created successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getBalance**
+> GetBalanceResponse getBalance()
+
+ Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetBalanceResponse**
+
+### 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** | Balance retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getFills**
+> GetFillsResponse getFills()
+
+ Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
+| **orderId** | [**string**] | Filter by order ID | (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|
+| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (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, returns results across all subaccounts. | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetFillsResponse**
+
+### 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** | Fills retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getPortfolioRestingOrderTotalValue**
+> GetPortfolioRestingOrderTotalValueResponse getPortfolioRestingOrderTotalValue()
+
+ Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetPortfolioRestingOrderTotalValueResponse**
+
+### 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** | Total resting order value retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getPositions**
+> GetPositionsResponse getPositions()
+
+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
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cursor** | [**string**] | The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page. | (optional) defaults to undefined|
+| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100. | (optional) defaults to 100|
+| **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 of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
+| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts. | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetPositionsResponse**
+
+### 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** | Positions retrieved successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getSettlements**
+> GetSettlementsResponse getSettlements()
+
+ Endpoint for getting the member\'s settlements historical track.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (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|
+| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
+| **eventTicker** | [**string**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
+| **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, returns results across all subaccounts. | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetSettlementsResponse**
+
+### 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** | Settlements retrieved successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getSubaccountBalances**
+> GetSubaccountBalancesResponse getSubaccountBalances()
+
+Gets balances for all subaccounts including the primary account.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetSubaccountBalancesResponse**
+
+### 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** | Balances retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getSubaccountTransfers**
+> GetSubaccountTransfersResponse getSubaccountTransfers()
+
+Gets a paginated list of all transfers between subaccounts for the authenticated user.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (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|
+
+
+### Return type
+
+**GetSubaccountTransfersResponse**
+
+### 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** | Transfers retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/PriceDistribution.md

@@ -0,0 +1,50 @@
+# PriceDistribution
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**open** | **number** | First traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [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. | [optional] [default to undefined]
+**low** | **number** | Lowest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [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. | [optional] [default to undefined]
+**high** | **number** | Highest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [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. | [optional] [default to undefined]
+**close** | **number** | Last traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [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. | [optional] [default to undefined]
+**mean** | **number** | Mean traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
+**mean_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]
+**previous** | **number** | Last traded YES contract price on the market before the candlestick period (in cents). May be null if there were no trades before the period. | [optional] [default to undefined]
+**previous_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]
+**min** | **number** | Minimum close price of any market during the candlestick period (in cents). | [optional] [default to undefined]
+**min_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]
+**max** | **number** | Maximum close price of any market during the candlestick period (in cents). | [optional] [default to undefined]
+**max_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]
+
+## Example
+
+```typescript
+import { PriceDistribution } from 'kalshi-typescript';
+
+const instance: PriceDistribution = {
+    open,
+    open_dollars,
+    low,
+    low_dollars,
+    high,
+    high_dollars,
+    close,
+    close_dollars,
+    mean,
+    mean_dollars,
+    previous,
+    previous_dollars,
+    min,
+    min_dollars,
+    max,
+    max_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/PriceDistributionHistorical.md

@@ -0,0 +1,30 @@
+# PriceDistributionHistorical
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**open** | **string** | Price of the first trade during the candlestick period (in dollars). Null if no trades occurred. | [default to undefined]
+**low** | **string** | Lowest trade price during the candlestick period (in dollars). Null if no trades occurred. | [default to undefined]
+**high** | **string** | Highest trade price during the candlestick period (in dollars). Null if no trades occurred. | [default to undefined]
+**close** | **string** | Price of the last trade during the candlestick period (in dollars). Null if no trades occurred. | [default to undefined]
+**mean** | **string** | Volume-weighted average price during the candlestick period (in dollars). Null if no trades occurred. | [default to undefined]
+**previous** | **string** | Close price from the previous candlestick period (in dollars). Null if this is the first candlestick or no prior trade exists. | [default to undefined]
+
+## Example
+
+```typescript
+import { PriceDistributionHistorical } from 'kalshi-typescript';
+
+const instance: PriceDistributionHistorical = {
+    open,
+    low,
+    high,
+    close,
+    mean,
+    previous,
+};
+```
+
+[[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/PriceRange.md

@@ -0,0 +1,24 @@
+# PriceRange
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **string** | Starting price for this range in dollars | [default to undefined]
+**end** | **string** | Ending price for this range in dollars | [default to undefined]
+**step** | **string** | Price step/tick size for this range in dollars | [default to undefined]
+
+## Example
+
+```typescript
+import { PriceRange } from 'kalshi-typescript';
+
+const instance: PriceRange = {
+    start,
+    end,
+    step,
+};
+```
+
+[[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/Quote.md

@@ -0,0 +1,72 @@
+# Quote
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the quote | [default to undefined]
+**rfq_id** | **string** | ID of the RFQ this quote is responding to | [default to undefined]
+**creator_id** | **string** | Public communications ID of the quote creator | [default to undefined]
+**rfq_creator_id** | **string** | Public communications ID of the RFQ creator | [default to undefined]
+**market_ticker** | **string** | The ticker of the market this quote is for | [default to undefined]
+**contracts** | **number** | Number of contracts in the quote | [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. 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]
+**yes_bid** | **number** | Bid price for YES contracts, in cents | [default to undefined]
+**no_bid** | **number** | Bid price for NO contracts, in cents | [default to undefined]
+**yes_bid_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]
+**no_bid_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]
+**created_ts** | **string** | Timestamp when the quote was created | [default to undefined]
+**updated_ts** | **string** | Timestamp when the quote was last updated | [default to undefined]
+**status** | **string** | Current status of the quote | [default to undefined]
+**accepted_side** | **string** | The side that was accepted (yes or no) | [optional] [default to undefined]
+**accepted_ts** | **string** | Timestamp when the quote was accepted | [optional] [default to undefined]
+**confirmed_ts** | **string** | Timestamp when the quote was confirmed | [optional] [default to undefined]
+**executed_ts** | **string** | Timestamp when the quote was executed | [optional] [default to undefined]
+**cancelled_ts** | **string** | Timestamp when the quote was cancelled | [optional] [default to undefined]
+**rest_remainder** | **boolean** | Whether to rest the remainder of the quote after execution | [optional] [default to undefined]
+**cancellation_reason** | **string** | Reason for quote cancellation if cancelled | [optional] [default to undefined]
+**creator_user_id** | **string** | User ID of the quote creator (private field) | [optional] [default to undefined]
+**rfq_creator_user_id** | **string** | User ID of the RFQ creator (private field) | [optional] [default to undefined]
+**rfq_target_cost_centi_cents** | **number** | DEPRECATED: Total value requested in the RFQ in centi-cents. Use rfq_target_cost_dollars instead. | [optional] [default to undefined]
+**rfq_target_cost_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]
+**rfq_creator_order_id** | **string** | Order ID for the RFQ creator (private field) | [optional] [default to undefined]
+**creator_order_id** | **string** | Order ID for the quote creator (private field) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Quote } from 'kalshi-typescript';
+
+const instance: Quote = {
+    id,
+    rfq_id,
+    creator_id,
+    rfq_creator_id,
+    market_ticker,
+    contracts,
+    contracts_fp,
+    yes_bid,
+    no_bid,
+    yes_bid_dollars,
+    no_bid_dollars,
+    created_ts,
+    updated_ts,
+    status,
+    accepted_side,
+    accepted_ts,
+    confirmed_ts,
+    executed_ts,
+    cancelled_ts,
+    rest_remainder,
+    cancellation_reason,
+    creator_user_id,
+    rfq_creator_user_id,
+    rfq_target_cost_centi_cents,
+    rfq_target_cost_dollars,
+    rfq_creator_order_id,
+    creator_order_id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RFQ.md

@@ -0,0 +1,50 @@
+# RFQ
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the RFQ | [default to undefined]
+**creator_id** | **string** | Public communications ID of the RFQ creator | [default to undefined]
+**market_ticker** | **string** | The ticker of the market this RFQ is for | [default to undefined]
+**contracts** | **number** | Number of contracts requested in the RFQ | [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. 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]
+**target_cost_centi_cents** | **number** | DEPRECATED: Total value of 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 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]
+**status** | **string** | Current status of the RFQ (open, closed) | [default to undefined]
+**created_ts** | **string** | Timestamp when the RFQ was created | [default to undefined]
+**mve_collection_ticker** | **string** | Ticker of the MVE collection this market belongs to | [optional] [default to undefined]
+**mve_selected_legs** | [**Array<MveSelectedLeg>**](MveSelectedLeg.md) | Selected legs for the MVE collection | [optional] [default to undefined]
+**rest_remainder** | **boolean** | Whether to rest the remainder of the RFQ after execution | [optional] [default to undefined]
+**cancellation_reason** | **string** | Reason for RFQ cancellation if cancelled | [optional] [default to undefined]
+**creator_user_id** | **string** | User ID of the RFQ creator (private field) | [optional] [default to undefined]
+**cancelled_ts** | **string** | Timestamp when the RFQ was cancelled | [optional] [default to undefined]
+**updated_ts** | **string** | Timestamp when the RFQ was last updated | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RFQ } from 'kalshi-typescript';
+
+const instance: RFQ = {
+    id,
+    creator_id,
+    market_ticker,
+    contracts,
+    contracts_fp,
+    target_cost_centi_cents,
+    target_cost_dollars,
+    status,
+    created_ts,
+    mve_collection_ticker,
+    mve_selected_legs,
+    rest_remainder,
+    cancellation_reason,
+    creator_user_id,
+    cancelled_ts,
+    updated_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/Schedule.md

@@ -0,0 +1,22 @@
+# Schedule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**standard_hours** | [**Array<WeeklySchedule>**](WeeklySchedule.md) | The standard operating hours of the exchange. All times are expressed in ET. Outside of these times trading will be unavailable. | [default to undefined]
+**maintenance_windows** | [**Array<MaintenanceWindow>**](MaintenanceWindow.md) | Scheduled maintenance windows, during which the exchange may be unavailable. | [default to undefined]
+
+## Example
+
+```typescript
+import { Schedule } from 'kalshi-typescript';
+
+const instance: Schedule = {
+    standard_hours,
+    maintenance_windows,
+};
+```
+
+[[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/ScopeList.md

@@ -0,0 +1,20 @@
+# ScopeList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scopes** | **Array<string>** | List of scopes | [default to undefined]
+
+## Example
+
+```typescript
+import { ScopeList } from 'kalshi-typescript';
+
+const instance: ScopeList = {
+    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/SearchApi.md

@@ -0,0 +1,69 @@
+# SearchApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getFiltersForSports**](#getfiltersforsports) | **GET** /search/filters_by_sport | Get Filters for Sports|
+|[**getTagsForSeriesCategories**](#gettagsforseriescategories) | **GET** /search/tags_by_categories | Get Tags for Series Categories|
+
+# **getFiltersForSports**
+> GetFiltersBySportsResponse getFiltersForSports()
+
+Retrieve available filters organized by sport.  This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes. 
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetFiltersBySportsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Filters retrieved successfully |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getTagsForSeriesCategories**
+> GetTagsForSeriesCategoriesResponse getTagsForSeriesCategories()
+
+Retrieve tags organized by series categories.  This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality. 
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetTagsForSeriesCategoriesResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Tags retrieved successfully |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+