kalshi-typescript/docs/CreateOrderRequest.md

OpenAPI client for kalshi-typescript

# CreateOrderRequest


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ticker** | **string** |  | [default to undefined]
**client_order_id** | **string** |  | [optional] [default to undefined]
**side** | **string** |  | [default to undefined]
**action** | **string** |  | [default to undefined]
**count** | **number** | Order quantity in contracts (whole contracts only). Provide count or count_fp; if both provided they must match. | [optional] [default to undefined]
**count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. 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. | [optional] [default to undefined]
**yes_price** | **number** |  | [optional] [default to undefined]
**no_price** | **number** |  | [optional] [default to undefined]
**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
**expiration_ts** | **number** |  | [optional] [default to undefined]
**time_in_force** | **string** |  | [optional] [default to undefined]
**buy_max_cost** | **number** | Maximum cost in cents. When specified, the order will automatically have Fill-or-Kill (FoK) behavior. | [optional] [default to undefined]
**post_only** | **boolean** |  | [optional] [default to undefined]
**reduce_only** | **boolean** |  | [optional] [default to undefined]
**sell_position_floor** | **number** | Deprecated: Use reduce_only instead. Only accepts value of 0. | [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** | The subaccount number to use for this order. 0 is the primary subaccount. | [optional] [default to 0]

## Example

```typescript
import { CreateOrderRequest } from 'kalshi-typescript';

const instance: CreateOrderRequest = {
    ticker,
    client_order_id,
    side,
    action,
    count,
    count_fp,
    yes_price,
    no_price,
    yes_price_dollars,
    no_price_dollars,
    expiration_ts,
    time_in_force,
    buy_max_cost,
    post_only,
    reduce_only,
    sell_position_floor,
    self_trade_prevention_type,
    order_group_id,
    cancel_order_on_pause,
    subaccount,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)