kalshi-typescript/docs/Order.md

OpenAPI client for kalshi-typescript

# 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_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_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. | [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_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_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_fill_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]
**maker_fill_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]
**taker_fees_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]
**maker_fees_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]
**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). | [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_dollars,
    no_price_dollars,
    fill_count_fp,
    remaining_count_fp,
    initial_count_fp,
    taker_fill_cost_dollars,
    maker_fill_cost_dollars,
    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)