kalshi-typescript/dist/models/event-data.d.ts

OpenAPI client for 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.11.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 { Market } from './market';
export interface EventData {
    /**
     * Unique identifier for this event.
     */
    'event_ticker': string;
    /**
     * Unique identifier for the series this event belongs to.
     */
    'series_ticker': string;
    /**
     * Shortened descriptive title for the event.
     */
    'sub_title': string;
    /**
     * Full title of the event.
     */
    'title': string;
    /**
     * Specifies how collateral is returned when markets settle (e.g., \'binary\' for standard yes/no markets).
     */
    'collateral_return_type': string;
    /**
     * If true, only one market in this event can resolve to \'yes\'. If false, multiple markets can resolve to \'yes\'.
     */
    'mutually_exclusive': boolean;
    /**
     * Event category (deprecated, use series-level category instead).
     * @deprecated
     */
    'category'?: string;
    /**
     * The specific date this event is based on. Only filled when the event uses a date strike (mutually exclusive with strike_period).
     */
    'strike_date'?: string | null;
    /**
     * The time period this event covers (e.g., \'week\', \'month\'). Only filled when the event uses a period strike (mutually exclusive with strike_date).
     */
    'strike_period'?: string | null;
    /**
     * Array of markets associated with this event. Only populated when \'with_nested_markets=true\' is specified in the request.
     */
    'markets'?: Array<Market>;
    /**
     * Whether this event is available to trade on brokers.
     */
    'available_on_brokers': boolean;
    /**
     * Additional metadata for the event.
     */
    'product_metadata': object;
    /**
     * Timestamp of when this event\'s metadata was last updated.
     */
    'last_updated_ts'?: string;
}