Documentation Index
Fetch the complete documentation index at: https://docs.kalshi.com/llms.txt
Use this file to discover all available pages before exploring further.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| ticker | str | ||
| client_order_id | str | [optional] | |
| side | str | ||
| action | str | ||
| count | int | Order quantity in contracts (whole contracts only). Provide count or count_fp; if both provided they must match. | [optional] |
| count_fp | str | Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0–2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] |
| yes_price | int | [optional] | |
| no_price | int | [optional] | |
| yes_price_dollars | str | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market’s price level structure. | [optional] |
| no_price_dollars | str | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market’s price level structure. | [optional] |
| expiration_ts | int | [optional] | |
| time_in_force | str | [optional] | |
| buy_max_cost | int | Maximum cost in cents. When specified, the order will automatically have Fill-or-Kill (FoK) behavior. | [optional] |
| post_only | bool | [optional] | |
| reduce_only | bool | [optional] | |
| sell_position_floor | int | Deprecated: Use reduce_only instead. Only accepts value of 0. | [optional] |
| self_trade_prevention_type | SelfTradePreventionType | [optional] | |
| order_group_id | str | The order group this order is part of | [optional] |
| cancel_order_on_pause | bool | 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] |
| subaccount | int | The subaccount number to use for this order. 0 is the primary subaccount. | [optional] [default to 0] |