kalshi-typescript/dist/models/create-rfqrequest.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.
 */
export interface CreateRFQRequest {
    /**
     * The ticker of the market for which to create an RFQ
     */
    'market_ticker': string;
    /**
     * The number of contracts for the RFQ. Whole contracts only. Contracts may be provided via contracts or contracts_fp; if both provided they must match.
     */
    '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;
    /**
     * DEPRECATED: The target cost for the RFQ in centi-cents. Use target_cost_dollars instead.
     * @deprecated
     */
    'target_cost_centi_cents'?: number;
    /**
     * US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure.
     */
    'target_cost_dollars'?: string;
    /**
     * Whether to rest the remainder of the RFQ after execution
     */
    'rest_remainder': boolean;
    /**
     * Whether to delete existing RFQs as part of this RFQ\'s creation
     */
    'replace_existing'?: boolean;
    /**
     * The subtrader to create the RFQ for (FCM members only)
     */
    'subtrader_id'?: string;
    /**
     * The subaccount number to create the RFQ for (direct members only; 0 for primary, 1-32 for subaccounts)
     */
    'subaccount'?: number;
}