kalshi-typescript
Version:
Official TypeScript SDK for the Kalshi API
73 lines (72 loc) • 3.05 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 Settlement {
/**
* The ticker symbol of the market that was settled.
*/
'ticker': string;
/**
* The event ticker symbol of the market that was settled.
*/
'event_ticker': string;
/**
* The outcome of the market settlement. \'yes\' = market resolved to YES, \'no\' = market resolved to NO, \'scalar\' = scalar market settled at a specific value, \'void\' = market was voided/cancelled and all positions returned at original cost.
*/
'market_result': SettlementMarketResultEnum;
/**
* Number of YES contracts owned at the time of settlement.
*/
'yes_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.
*/
'yes_count_fp': string;
/**
* Total cost basis of all YES contracts in cents.
*/
'yes_total_cost': number;
/**
* Number of NO contracts owned at the time of settlement.
*/
'no_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.
*/
'no_count_fp': string;
/**
* Total cost basis of all NO contracts in cents.
*/
'no_total_cost': number;
/**
* Total revenue earned from this settlement in cents (winning contracts pay out 100 cents each).
*/
'revenue': number;
/**
* Timestamp when the market was settled and payouts were processed.
*/
'settled_time': string;
/**
* US dollar amount as a fixed-point decimal string with exactly 4 decimal places
*/
'fee_cost': string;
/**
* Payout of a single yes contract in cents.
*/
'value'?: number | null;
}
export declare const SettlementMarketResultEnum: {
readonly Yes: "yes";
readonly No: "no";
readonly Scalar: "scalar";
readonly Void: "void";
};
export type SettlementMarketResultEnum = typeof SettlementMarketResultEnum[keyof typeof SettlementMarketResultEnum];