kalshi-typescript
Version:
Official TypeScript SDK for the Kalshi API
131 lines (130 loc) • 3.79 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 Quote {
/**
* Unique identifier for the quote
*/
'id': string;
/**
* ID of the RFQ this quote is responding to
*/
'rfq_id': string;
/**
* Public communications ID of the quote creator
*/
'creator_id': string;
/**
* Public communications ID of the RFQ creator
*/
'rfq_creator_id': string;
/**
* The ticker of the market this quote is for
*/
'market_ticker': string;
/**
* Number of contracts in the quote
*/
'contracts': 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.
*/
'contracts_fp': string;
/**
* Bid price for YES contracts, in cents
*/
'yes_bid': number;
/**
* Bid price for NO contracts, in cents
*/
'no_bid': number;
/**
* US dollar amount as a fixed-point decimal string with exactly 4 decimal places
*/
'yes_bid_dollars': string;
/**
* US dollar amount as a fixed-point decimal string with exactly 4 decimal places
*/
'no_bid_dollars': string;
/**
* Timestamp when the quote was created
*/
'created_ts': string;
/**
* Timestamp when the quote was last updated
*/
'updated_ts': string;
/**
* Current status of the quote
*/
'status': QuoteStatusEnum;
/**
* The side that was accepted (yes or no)
*/
'accepted_side'?: QuoteAcceptedSideEnum;
/**
* Timestamp when the quote was accepted
*/
'accepted_ts'?: string;
/**
* Timestamp when the quote was confirmed
*/
'confirmed_ts'?: string;
/**
* Timestamp when the quote was executed
*/
'executed_ts'?: string;
/**
* Timestamp when the quote was cancelled
*/
'cancelled_ts'?: string;
/**
* Whether to rest the remainder of the quote after execution
*/
'rest_remainder'?: boolean;
/**
* Reason for quote cancellation if cancelled
*/
'cancellation_reason'?: string;
/**
* User ID of the quote creator (private field)
*/
'creator_user_id'?: string;
/**
* User ID of the RFQ creator (private field)
*/
'rfq_creator_user_id'?: string;
/**
* Total value requested in the RFQ in centi-cents
*/
'rfq_target_cost_centi_cents'?: number;
/**
* Order ID for the RFQ creator (private field)
*/
'rfq_creator_order_id'?: string;
/**
* Order ID for the quote creator (private field)
*/
'creator_order_id'?: string;
}
export declare const QuoteStatusEnum: {
readonly Open: "open";
readonly Accepted: "accepted";
readonly Confirmed: "confirmed";
readonly Executed: "executed";
readonly Cancelled: "cancelled";
};
export type QuoteStatusEnum = typeof QuoteStatusEnum[keyof typeof QuoteStatusEnum];
export declare const QuoteAcceptedSideEnum: {
readonly Yes: "yes";
readonly No: "no";
};
export type QuoteAcceptedSideEnum = typeof QuoteAcceptedSideEnum[keyof typeof QuoteAcceptedSideEnum];