kalshi-typescript 3.6.0 → 3.7.0

package/docs/MarketCandlestick.md

@@ -0,0 +1,34 @@
+# MarketCandlestick
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**end_period_ts** | **number** | Unix timestamp for the inclusive end of the candlestick period. | [default to undefined]
+**yes_bid** | [**BidAskDistribution**](BidAskDistribution.md) |  | [default to undefined]
+**yes_ask** | [**BidAskDistribution**](BidAskDistribution.md) |  | [default to undefined]
+**price** | [**PriceDistribution**](PriceDistribution.md) |  | [default to undefined]
+**volume** | **number** | Number of contracts bought on the market during the candlestick period. | [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. 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]
+**open_interest** | **number** | Number of contracts bought on the market by end of the candlestick period (end_period_ts). | [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. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+
+## Example
+
+```typescript
+import { MarketCandlestick } from 'kalshi-typescript';
+
+const instance: MarketCandlestick = {
+    end_period_ts,
+    yes_bid,
+    yes_ask,
+    price,
+    volume,
+    volume_fp,
+    open_interest,
+    open_interest_fp,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MarketCandlestickHistorical.md

@@ -0,0 +1,30 @@
+# MarketCandlestickHistorical
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**end_period_ts** | **number** | Unix timestamp for the inclusive end of the candlestick period. | [default to undefined]
+**yes_bid** | [**BidAskDistributionHistorical**](BidAskDistributionHistorical.md) |  | [default to undefined]
+**yes_ask** | [**BidAskDistributionHistorical**](BidAskDistributionHistorical.md) |  | [default to undefined]
+**price** | [**PriceDistributionHistorical**](PriceDistributionHistorical.md) |  | [default to undefined]
+**volume** | **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]
+**open_interest** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+
+## Example
+
+```typescript
+import { MarketCandlestickHistorical } from 'kalshi-typescript';
+
+const instance: MarketCandlestickHistorical = {
+    end_period_ts,
+    yes_bid,
+    yes_ask,
+    price,
+    volume,
+    open_interest,
+};
+```
+
+[[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/MarketCandlesticksResponse.md

@@ -0,0 +1,22 @@
+# MarketCandlesticksResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market_ticker** | **string** | Market ticker string (e.g., \'INXD-24JAN01\'). | [default to undefined]
+**candlesticks** | [**Array<MarketCandlestick>**](MarketCandlestick.md) | Array of candlestick data points for the market. Includes an initial data point at the start timestamp when available. | [default to undefined]
+
+## Example
+
+```typescript
+import { MarketCandlesticksResponse } from 'kalshi-typescript';
+
+const instance: MarketCandlesticksResponse = {
+    market_ticker,
+    candlesticks,
+};
+```
+
+[[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/MarketMetadata.md

@@ -0,0 +1,24 @@
+# MarketMetadata
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market_ticker** | **string** | The ticker of the market. | [default to undefined]
+**image_url** | **string** | A path to an image that represents this market. | [default to undefined]
+**color_code** | **string** | The color code for the market. | [default to undefined]
+
+## Example
+
+```typescript
+import { MarketMetadata } from 'kalshi-typescript';
+
+const instance: MarketMetadata = {
+    market_ticker,
+    image_url,
+    color_code,
+};
+```
+
+[[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/MarketPosition.md

@@ -0,0 +1,44 @@
+# MarketPosition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ticker** | **string** | Unique identifier for the market | [default to undefined]
+**total_traded** | **number** | Total spent on this market in cents | [default to undefined]
+**total_traded_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]
+**position** | **number** | Number of contracts bought in this market. Negative means NO contracts and positive means YES contracts | [default to undefined]
+**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. 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]
+**market_exposure** | **number** | Cost of the aggregate market position in cents | [default to undefined]
+**market_exposure_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]
+**realized_pnl** | **number** | Locked in profit and loss, in cents | [default to undefined]
+**realized_pnl_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]
+**resting_orders_count** | **number** | [DEPRECATED] Aggregate size of resting orders in contract units | [default to undefined]
+**fees_paid** | **number** | Fees paid on fill orders, in cents | [default to undefined]
+**fees_paid_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]
+**last_updated_ts** | **string** | Last time the position is updated | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MarketPosition } from 'kalshi-typescript';
+
+const instance: MarketPosition = {
+    ticker,
+    total_traded,
+    total_traded_dollars,
+    position,
+    position_fp,
+    market_exposure,
+    market_exposure_dollars,
+    realized_pnl,
+    realized_pnl_dollars,
+    resting_orders_count,
+    fees_paid,
+    fees_paid_dollars,
+    last_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/Milestone.md

@@ -0,0 +1,42 @@
+# Milestone
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the milestone. | [default to undefined]
+**category** | **string** | Category of the milestone. | [default to undefined]
+**type** | **string** | Type of the milestone. | [default to undefined]
+**start_date** | **string** | Start date of the milestone. | [default to undefined]
+**end_date** | **string** | End date of the milestone, if any. | [optional] [default to undefined]
+**related_event_tickers** | **Array<string>** | List of event tickers related to this milestone. | [default to undefined]
+**title** | **string** | Title of the milestone. | [default to undefined]
+**notification_message** | **string** | Notification message for the milestone. | [default to undefined]
+**source_id** | **string** | Source id of milestone if available. | [optional] [default to undefined]
+**details** | **{ [key: string]: any; }** | Additional details about the milestone. | [default to undefined]
+**primary_event_tickers** | **Array<string>** | List of event tickers directly related to the outcome of this milestone. | [default to undefined]
+**last_updated_ts** | **string** | Last time this structured target was updated. | [default to undefined]
+
+## Example
+
+```typescript
+import { Milestone } from 'kalshi-typescript';
+
+const instance: Milestone = {
+    id,
+    category,
+    type,
+    start_date,
+    end_date,
+    related_event_tickers,
+    title,
+    notification_message,
+    source_id,
+    details,
+    primary_event_tickers,
+    last_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/MilestoneApi.md

@@ -0,0 +1,85 @@
+# MilestoneApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getMilestone**](#getmilestone) | **GET** /milestones/{milestone_id} | Get Milestone|
+|[**getMilestones**](#getmilestones) | **GET** /milestones | Get Milestones|
+
+# **getMilestone**
+> GetMilestoneResponse getMilestone()
+
+ Endpoint for getting data about a specific milestone by its ID.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **milestoneId** | [**string**] | Milestone ID | defaults to undefined|
+
+
+### Return type
+
+**GetMilestoneResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Milestone retrieved successfully |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not Found |  -  |
+|**500** | Internal Server Error |  -  |
+
+# **getMilestones**
+> GetMilestonesResponse getMilestones()
+
+Minimum start date to filter milestones. Format: RFC3339 timestamp
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Number of milestones to return per page | defaults to undefined|
+| **minimumStartDate** | [**string**] | Minimum start date to filter milestones. Format RFC3339 timestamp | (optional) defaults to undefined|
+| **category** | [**string**] | Filter by milestone category | (optional) defaults to undefined|
+| **competition** | [**string**] | Filter by competition | (optional) defaults to undefined|
+| **sourceId** | [**string**] | Filter by source id | (optional) defaults to undefined|
+| **type** | [**string**] | Filter by milestone type | (optional) defaults to undefined|
+| **relatedEventTicker** | [**string**] | Filter by related event ticker | (optional) defaults to undefined|
+| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetMilestonesResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Milestones retrieved successfully |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal Server Error |  -  |
+

package/docs/MultivariateApi.md

@@ -0,0 +1,188 @@
+# MultivariateApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createMarketInMultivariateEventCollection**](#createmarketinmultivariateeventcollection) | **POST** /multivariate_event_collections/{collection_ticker} | Create Market In Multivariate Event Collection|
+|[**getMultivariateEventCollection**](#getmultivariateeventcollection) | **GET** /multivariate_event_collections/{collection_ticker} | Get Multivariate Event Collection|
+|[**getMultivariateEventCollectionLookupHistory**](#getmultivariateeventcollectionlookuphistory) | **GET** /multivariate_event_collections/{collection_ticker}/lookup | Get Multivariate Event Collection Lookup History|
+|[**getMultivariateEventCollections**](#getmultivariateeventcollections) | **GET** /multivariate_event_collections | Get Multivariate Event Collections|
+|[**lookupTickersForMarketInMultivariateEventCollection**](#lookuptickersformarketinmultivariateeventcollection) | **PUT** /multivariate_event_collections/{collection_ticker}/lookup | Lookup Tickers For Market In Multivariate Event Collection|
+
+# **createMarketInMultivariateEventCollection**
+> CreateMarketInMultivariateEventCollectionResponse createMarketInMultivariateEventCollection(createMarketInMultivariateEventCollectionRequest)
+
+ Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createMarketInMultivariateEventCollectionRequest** | **CreateMarketInMultivariateEventCollectionRequest**|  | |
+| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
+
+
+### Return type
+
+**CreateMarketInMultivariateEventCollectionResponse**
+
+### 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** | Market created successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**500** | Internal server error |  -  |
+
+# **getMultivariateEventCollection**
+> GetMultivariateEventCollectionResponse getMultivariateEventCollection()
+
+ Endpoint for getting data about a multivariate event collection by its ticker.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
+
+
+### Return type
+
+**GetMultivariateEventCollectionResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Collection retrieved successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **getMultivariateEventCollectionLookupHistory**
+> GetMultivariateEventCollectionLookupHistoryResponse getMultivariateEventCollectionLookupHistory()
+
+ Endpoint for retrieving which markets in an event collection were recently looked up.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
+| **lookbackSeconds** | [**10 | 60 | 300 | 3600**]**Array<10 &#124; 60 &#124; 300 &#124; 3600>** | Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600. | defaults to undefined|
+
+
+### Return type
+
+**GetMultivariateEventCollectionLookupHistoryResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Lookup history retrieved successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**500** | Internal server error |  -  |
+
+# **getMultivariateEventCollections**
+> GetMultivariateEventCollectionsResponse getMultivariateEventCollections()
+
+ Endpoint for getting data about multivariate event collections.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **status** | [**&#39;unopened&#39; | &#39;open&#39; | &#39;closed&#39;**]**Array<&#39;unopened&#39; &#124; &#39;open&#39; &#124; &#39;closed&#39;>** | Only return collections of a certain status. Can be unopened, open, or closed. | (optional) defaults to undefined|
+| **associatedEventTicker** | [**string**] | Only return collections associated with a particular event ticker. | (optional) defaults to undefined|
+| **seriesTicker** | [**string**] | Only return collections with a particular series ticker. | (optional) defaults to undefined|
+| **limit** | [**number**] | Specify the maximum number of results. | (optional) defaults to undefined|
+| **cursor** | [**string**] | The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point. | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetMultivariateEventCollectionsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Collections retrieved successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**500** | Internal server error |  -  |
+
+# **lookupTickersForMarketInMultivariateEventCollection**
+> LookupTickersForMarketInMultivariateEventCollectionResponse lookupTickersForMarketInMultivariateEventCollection(lookupTickersForMarketInMultivariateEventCollectionRequest)
+
+ Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **lookupTickersForMarketInMultivariateEventCollectionRequest** | **LookupTickersForMarketInMultivariateEventCollectionRequest**|  | |
+| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
+
+
+### Return type
+
+**LookupTickersForMarketInMultivariateEventCollectionResponse**
+
+### 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** | Market looked up successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/MultivariateEventCollection.md

@@ -0,0 +1,46 @@
+# MultivariateEventCollection
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**collection_ticker** | **string** | Unique identifier for the collection. | [default to undefined]
+**series_ticker** | **string** | Series associated with the collection. Events produced in the collection will be associated with this series. | [default to undefined]
+**title** | **string** | Title of the collection. | [default to undefined]
+**description** | **string** | Short description of the collection. | [default to undefined]
+**open_date** | **string** | The open date of the collection. Before this time, the collection cannot be interacted with. | [default to undefined]
+**close_date** | **string** | The close date of the collection. After this time, the collection cannot be interacted with. | [default to undefined]
+**associated_events** | [**Array<AssociatedEvent>**](AssociatedEvent.md) | List of events with their individual configuration. | [default to undefined]
+**associated_event_tickers** | **Array<string>** | [DEPRECATED - Use associated_events instead] A list of events associated with the collection. Markets in these events can be passed as inputs to the Lookup and Create endpoints. | [default to undefined]
+**is_ordered** | **boolean** | Whether the collection is ordered. If true, the order of markets passed into Lookup/Create affects the output. If false, the order does not matter. | [default to undefined]
+**is_single_market_per_event** | **boolean** | [DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create. | [default to undefined]
+**is_all_yes** | **boolean** | [DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of \'yes\' may be used. | [default to undefined]
+**size_min** | **number** | The minimum number of markets that must be passed into Lookup/Create (inclusive). | [default to undefined]
+**size_max** | **number** | The maximum number of markets that must be passed into Lookup/Create (inclusive). | [default to undefined]
+**functional_description** | **string** | A functional description of the collection describing how inputs affect the output. | [default to undefined]
+
+## Example
+
+```typescript
+import { MultivariateEventCollection } from 'kalshi-typescript';
+
+const instance: MultivariateEventCollection = {
+    collection_ticker,
+    series_ticker,
+    title,
+    description,
+    open_date,
+    close_date,
+    associated_events,
+    associated_event_tickers,
+    is_ordered,
+    is_single_market_per_event,
+    is_all_yes,
+    size_min,
+    size_max,
+    functional_description,
+};
+```
+
+[[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/MveSelectedLeg.md

@@ -0,0 +1,26 @@
+# MveSelectedLeg
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_ticker** | **string** | Unique identifier for the selected event | [optional] [default to undefined]
+**market_ticker** | **string** | Unique identifier for the selected market | [optional] [default to undefined]
+**side** | **string** | The side of the selected market | [optional] [default to undefined]
+**yes_settlement_value_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 { MveSelectedLeg } from 'kalshi-typescript';
+
+const instance: MveSelectedLeg = {
+    event_ticker,
+    market_ticker,
+    side,
+    yes_settlement_value_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/Order.md

@@ -0,0 +1,86 @@
+# Order
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_id** | **string** |  | [default to undefined]
+**user_id** | **string** | Unique identifier for users | [default to undefined]
+**client_order_id** | **string** |  | [default to undefined]
+**ticker** | **string** |  | [default to undefined]
+**side** | **string** |  | [default to undefined]
+**action** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**status** | [**OrderStatus**](OrderStatus.md) |  | [default to undefined]
+**yes_price** | **number** |  | [default to undefined]
+**no_price** | **number** |  | [default to undefined]
+**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**fill_count** | **number** | The number of contracts that have been filled | [default to undefined]
+**fill_count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**remaining_count** | **number** |  | [default to undefined]
+**remaining_count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**initial_count** | **number** | The initial size of the order (contract units) | [default to undefined]
+**initial_count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**taker_fees** | **number** | Fees paid on filled taker contracts, in cents | [default to undefined]
+**maker_fees** | **number** | Fees paid on filled maker contracts, in cents | [default to undefined]
+**taker_fill_cost** | **number** | The cost of filled taker orders in cents | [default to undefined]
+**maker_fill_cost** | **number** | The cost of filled maker orders in cents | [default to undefined]
+**taker_fill_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. | [default to undefined]
+**maker_fill_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. | [default to undefined]
+**queue_position** | **number** | **DEPRECATED**: This field is deprecated and will always return 0. Please use the GET /portfolio/orders/{order_id}/queue_position endpoint instead | [default to undefined]
+**taker_fees_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]
+**maker_fees_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]
+**expiration_time** | **string** |  | [optional] [default to undefined]
+**created_time** | **string** |  | [optional] [default to undefined]
+**last_update_time** | **string** | The last update to an order (modify, cancel, fill) | [optional] [default to undefined]
+**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). Present for direct users. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Order } from 'kalshi-typescript';
+
+const instance: Order = {
+    order_id,
+    user_id,
+    client_order_id,
+    ticker,
+    side,
+    action,
+    type,
+    status,
+    yes_price,
+    no_price,
+    yes_price_dollars,
+    no_price_dollars,
+    fill_count,
+    fill_count_fp,
+    remaining_count,
+    remaining_count_fp,
+    initial_count,
+    initial_count_fp,
+    taker_fees,
+    maker_fees,
+    taker_fill_cost,
+    maker_fill_cost,
+    taker_fill_cost_dollars,
+    maker_fill_cost_dollars,
+    queue_position,
+    taker_fees_dollars,
+    maker_fees_dollars,
+    expiration_time,
+    created_time,
+    last_update_time,
+    self_trade_prevention_type,
+    order_group_id,
+    cancel_order_on_pause,
+    subaccount_number,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)