Documentation
    Preparing search index...

    Interface RedeemLiveProceeds

    What a live close credits the account, decomposed.

    interface RedeemLiveProceeds {
        exactProbabilities: boolean;
        fees: {
            builder: number;
            impactRebate: number;
            penalty: number;
            trading: number;
        };
        gross: number;
        probability: number;
        proceeds: number;
        proceedsPerContract: number;
        quantityClosed: number;
        raw: {
            builderFee: bigint;
            gross: bigint;
            impactRebate: bigint;
            penaltyFee: bigint;
            probability: bigint;
            proceeds: bigint;
            quantityClosed: bigint;
            remainingQuantity: bigint
            | null;
            tradingFee: bigint;
        };
        remainingQuantity: number
        | null;
    }
    Index
    exactProbabilities fees gross probability proceeds proceedsPerContract quantityClosed raw remainingQuantity
    exactProbabilities: boolean

    Identifies raw probability inputs; does not verify their source or state freshness.

    fees: {
        builder: number;
        impactRebate: number;
        penalty: number;
        trading: number;
    }
    gross: number

    Close value before fees: the range's current probability times the closed payout.

    probability: number

    Current range probability, 0..1, before amount rounding and fees.

    proceeds: number

    NET credited to the account.

    proceedsPerContract: number

    Net credited per $1 of closed payout; includes fees and the inventory rebate.

    quantityClosed: number
    raw: {
        builderFee: bigint;
        gross: bigint;
        impactRebate: bigint;
        penaltyFee: bigint;
        probability: bigint;
        proceeds: bigint;
        quantityClosed: bigint;
        remainingQuantity: bigint | null;
        tradingFee: bigint;
    }

    Type Declaration

    • builderFee: bigint
    • gross: bigint
    • impactRebate: bigint
    • penaltyFee: bigint
    • probability: bigint

      1e9-scaled range probability; locally priced inputs remain approximate.

    • proceeds: bigint
    • quantityClosed: bigint
    • remainingQuantity: bigint | null
    • tradingFee: bigint
    remainingQuantity: number | null

    Unclosed payout quantity, or null when positionQuantity was not supplied.

    Settings
    Member Visibility

    On This Page
    Properties