kalshi-typescript/dist/models/order.d.ts

OpenAPI client for kalshi-typescript

/**
 * Kalshi Trade API Manual Endpoints
 * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
 *
 * The version of the OpenAPI document: 3.11.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { OrderStatus } from './order-status';
import type { SelfTradePreventionType } from './self-trade-prevention-type';
export interface Order {
    'order_id': string;
    /**
     * Unique identifier for users
     */
    'user_id': string;
    'client_order_id': string;
    'ticker': string;
    'side': OrderSideEnum;
    'action': OrderActionEnum;
    'type': OrderTypeEnum;
    'status': OrderStatus;
    /**
     * 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.
     */
    '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.
     */
    'no_price_dollars': 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.
     */
    '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.
     */
    '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.
     */
    'initial_count_fp': 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.
     */
    '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.
     */
    '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.
     */
    '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.
     */
    'maker_fees_dollars': string;
    'expiration_time'?: string | null;
    'created_time'?: string | null;
    /**
     * The last update to an order (modify, cancel, fill)
     */
    'last_update_time'?: string | null;
    'self_trade_prevention_type'?: SelfTradePreventionType;
    /**
     * The order group this order is part of
     */
    'order_group_id'?: string | null;
    /**
     * 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.
     */
    'cancel_order_on_pause'?: boolean;
    /**
     * Subaccount number (0 for primary, 1-32 for subaccounts).
     */
    'subaccount_number'?: number | null;
}
export declare const OrderSideEnum: {
    readonly Yes: "yes";
    readonly No: "no";
};
export type OrderSideEnum = typeof OrderSideEnum[keyof typeof OrderSideEnum];
export declare const OrderActionEnum: {
    readonly Buy: "buy";
    readonly Sell: "sell";
};
export type OrderActionEnum = typeof OrderActionEnum[keyof typeof OrderActionEnum];
export declare const OrderTypeEnum: {
    readonly Limit: "limit";
    readonly Market: "market";
};
export type OrderTypeEnum = typeof OrderTypeEnum[keyof typeof OrderTypeEnum];