kalshi-typescript
Version:
Official TypeScript SDK for the Kalshi API
72 lines (71 loc) • 2.54 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.
*/
export interface AmendOrderRequest {
/**
* Optional subaccount number to use for this amendment (0 for primary, 1-32 for subaccounts)
*/
'subaccount'?: number;
/**
* Market ticker
*/
'ticker': string;
/**
* Side of the order
*/
'side': AmendOrderRequestSideEnum;
/**
* Action of the order
*/
'action': AmendOrderRequestActionEnum;
/**
* The original client-specified order ID to be amended
*/
'client_order_id'?: string;
/**
* The new client-specified order ID after amendment
*/
'updated_client_order_id'?: string;
/**
* Updated yes price for the order in cents
*/
'yes_price'?: number;
/**
* Updated no price for the order in cents
*/
'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;
/**
* Updated quantity for the order (whole contracts only). If updating quantity, provide count or count_fp; if both provided they must match.
*/
'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.
*/
'count_fp'?: string;
}
export declare const AmendOrderRequestSideEnum: {
readonly Yes: "yes";
readonly No: "no";
};
export type AmendOrderRequestSideEnum = typeof AmendOrderRequestSideEnum[keyof typeof AmendOrderRequestSideEnum];
export declare const AmendOrderRequestActionEnum: {
readonly Buy: "buy";
readonly Sell: "sell";
};
export type AmendOrderRequestActionEnum = typeof AmendOrderRequestActionEnum[keyof typeof AmendOrderRequestActionEnum];