kalshi-typescript/models/incentive-program.ts

OpenAPI client for kalshi-typescript

/* tslint:disable */
/* eslint-disable */
/**
 * 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.
 */



export interface IncentiveProgram {
    /**
     * Unique identifier for the incentive program
     */
    'id': string;
    /**
     * The unique identifier of the market associated with this incentive program
     */
    'market_id': string;
    /**
     * The ticker symbol of the market associated with this incentive program
     */
    'market_ticker': string;
    /**
     * Type of incentive program
     */
    'incentive_type': IncentiveProgramIncentiveTypeEnum;
    /**
     * Start date of the incentive program
     */
    'start_date': string;
    /**
     * End date of the incentive program
     */
    'end_date': string;
    /**
     * Total reward for the period in centi-cents
     */
    'period_reward': number;
    /**
     * Whether the incentive has been paid out
     */
    'paid_out': boolean;
    /**
     * Discount factor in basis points (optional)
     */
    'discount_factor_bps'?: number | null;
    /**
     * 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.
     */
    'target_size_fp'?: string;
}

export const IncentiveProgramIncentiveTypeEnum = {
    Liquidity: 'liquidity',
    Volume: 'volume'
} as const;

export type IncentiveProgramIncentiveTypeEnum = typeof IncentiveProgramIncentiveTypeEnum[keyof typeof IncentiveProgramIncentiveTypeEnum];