kalshi-typescript
Version:
Official TypeScript SDK for the Kalshi API
124 lines (123 loc) • 5.01 kB
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.6.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;
'yes_price': number;
'no_price': number;
/**
* US dollar amount as a fixed-point decimal string with exactly 4 decimal places
*/
'yes_price_dollars': string;
/**
* US dollar amount as a fixed-point decimal string with exactly 4 decimal places
*/
'no_price_dollars': string;
/**
* The number of contracts that have been filled
*/
'fill_count': number;
/**
* 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;
'remaining_count': number;
/**
* 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;
/**
* The initial size of the order (contract units)
*/
'initial_count': number;
/**
* 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;
/**
* Fees paid on filled taker contracts, in cents
*/
'taker_fees': number;
/**
* Fees paid on filled maker contracts, in cents
*/
'maker_fees': number;
/**
* The cost of filled taker orders in cents
*/
'taker_fill_cost': number;
/**
* The cost of filled maker orders in cents
*/
'maker_fill_cost': number;
/**
* US dollar amount as a fixed-point decimal string with exactly 4 decimal places
*/
'taker_fill_cost_dollars': string;
/**
* US dollar amount as a fixed-point decimal string with exactly 4 decimal places
*/
'maker_fill_cost_dollars': string;
/**
* **DEPRECATED**: This field is deprecated and will always return 0. Please use the GET /portfolio/orders/{order_id}/queue_position endpoint instead
*/
'queue_position': number;
/**
* US dollar amount as a fixed-point decimal string with exactly 4 decimal places
*/
'taker_fees_dollars'?: string;
/**
* US dollar amount as a fixed-point decimal string with exactly 4 decimal places
*/
'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;
}
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];