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.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 { MveSelectedLeg } from './mve-selected-leg'; import type { PriceRange } from './price-range'; export interface Market { 'ticker': string; 'event_ticker': string; /** * Identifies the type of market */ 'market_type': MarketMarketTypeEnum; /** * @deprecated */ 'title': string; /** * @deprecated */ 'subtitle': string; /** * Shortened title for the yes side of this market */ 'yes_sub_title': string; /** * Shortened title for the no side of this market */ 'no_sub_title': string; 'created_time': string; /** * Time of the last market stats update */ 'updated_time': string; 'open_time': string; 'close_time': string; /** * Time when this market is expected to expire */ 'expected_expiration_time'?: string | null; /** * @deprecated */ 'expiration_time': string; /** * Latest possible time for this market to expire */ 'latest_expiration_time': string; /** * The amount of time after determination that the market settles */ 'settlement_timer_seconds': number; /** * The current status of the market in its lifecycle. */ 'status': MarketStatusEnum; /** * DEPRECATED: Use price_level_structure and price_ranges instead. * @deprecated */ 'response_price_units': MarketResponsePriceUnitsEnum; /** * DEPRECATED: Use yes_bid_dollars instead. * @deprecated */ 'yes_bid': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'yes_bid_dollars': string; /** * DEPRECATED: Use yes_ask_dollars instead. * @deprecated */ 'yes_ask': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'yes_ask_dollars': string; /** * DEPRECATED: Use no_bid_dollars instead. * @deprecated */ 'no_bid': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'no_bid_dollars': string; /** * DEPRECATED: Use no_ask_dollars instead. * @deprecated */ 'no_ask': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'no_ask_dollars': string; /** * DEPRECATED: Use last_price_dollars instead. * @deprecated */ 'last_price': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'last_price_dollars': string; 'volume': 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. */ 'volume_fp': string; 'volume_24h': 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. */ 'volume_24h_fp': string; 'result': MarketResultEnum; 'can_close_early': boolean; /** * Number of contracts bought on this market disconsidering netting */ 'open_interest': 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. */ 'open_interest_fp': string; /** * DEPRECATED: Use notional_value_dollars instead. * @deprecated */ 'notional_value': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'notional_value_dollars': string; /** * DEPRECATED: Use previous_yes_bid_dollars instead. * @deprecated */ 'previous_yes_bid': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'previous_yes_bid_dollars': string; /** * DEPRECATED: Use previous_yes_ask_dollars instead. * @deprecated */ 'previous_yes_ask': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'previous_yes_ask_dollars': string; /** * DEPRECATED: Use previous_price_dollars instead. * @deprecated */ 'previous_price': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'previous_price_dollars': string; /** * DEPRECATED: Use liquidity_dollars instead. * @deprecated */ 'liquidity': number; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'liquidity_dollars': string; /** * The settlement value of the YES/LONG side of the contract in cents. Only filled after determination */ 'settlement_value'?: number | null; /** * US dollar amount as a fixed-point decimal string with exactly 4 decimal places */ 'settlement_value_dollars'?: string; /** * Timestamp when the market was settled. Only filled for settled markets */ 'settlement_ts'?: string | null; /** * The value that was considered for the settlement */ 'expiration_value': string; /** * Time when this market\'s fee waiver expires */ 'fee_waiver_expiration_time'?: string | null; /** * The condition under which the market can close early */ 'early_close_condition'?: string | null; /** * DEPRECATED: Use price_level_structure and price_ranges instead. * @deprecated */ 'tick_size': number; /** * Strike type defines how the market strike is defined and evaluated */ 'strike_type'?: MarketStrikeTypeEnum; /** * Minimum expiration value that leads to a YES settlement */ 'floor_strike'?: number | null; /** * Maximum expiration value that leads to a YES settlement */ 'cap_strike'?: number | null; /** * Mapping from expiration values to settlement values */ 'functional_strike'?: string | null; /** * Expiration value for each target that leads to a YES settlement */ 'custom_strike'?: object | null; /** * A plain language description of the most important market terms */ 'rules_primary': string; /** * A plain language description of secondary market terms */ 'rules_secondary': string; /** * The ticker of the multivariate event collection */ 'mve_collection_ticker'?: string; 'mve_selected_legs'?: Array<MveSelectedLeg>; 'primary_participant_key'?: string | null; /** * Price level structure for this market, defining price ranges and tick sizes */ 'price_level_structure': string; /** * Valid price ranges for orders on this market */ 'price_ranges': Array<PriceRange>; /** * If true, the market may be removed after determination if there is no activity on it */ 'is_provisional'?: boolean; } export declare const MarketMarketTypeEnum: { readonly Binary: "binary"; readonly Scalar: "scalar"; }; export type MarketMarketTypeEnum = typeof MarketMarketTypeEnum[keyof typeof MarketMarketTypeEnum]; export declare const MarketStatusEnum: { readonly Initialized: "initialized"; readonly Inactive: "inactive"; readonly Active: "active"; readonly Closed: "closed"; readonly Determined: "determined"; readonly Disputed: "disputed"; readonly Amended: "amended"; readonly Finalized: "finalized"; }; export type MarketStatusEnum = typeof MarketStatusEnum[keyof typeof MarketStatusEnum]; export declare const MarketResponsePriceUnitsEnum: { readonly UsdCent: "usd_cent"; }; export type MarketResponsePriceUnitsEnum = typeof MarketResponsePriceUnitsEnum[keyof typeof MarketResponsePriceUnitsEnum]; export declare const MarketResultEnum: { readonly Yes: "yes"; readonly No: "no"; readonly Scalar: "scalar"; readonly Empty: ""; }; export type MarketResultEnum = typeof MarketResultEnum[keyof typeof MarketResultEnum]; export declare const MarketStrikeTypeEnum: { readonly Greater: "greater"; readonly GreaterOrEqual: "greater_or_equal"; readonly Less: "less"; readonly LessOrEqual: "less_or_equal"; readonly Between: "between"; readonly Functional: "functional"; readonly Custom: "custom"; readonly Structured: "structured"; }; export type MarketStrikeTypeEnum = typeof MarketStrikeTypeEnum[keyof typeof MarketStrikeTypeEnum];