aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface ApiPerpetualsCreateCsvRebatesBody

    Request body for generating a CSV-formatted rebate report.

    This corresponds to POST /api/perpetuals/rebates/create-csv-rebates.

    Produces a CSV string containing per-account rebate and reward data. When accountIds is omitted or empty, all eligible accounts are included.

    interface ApiPerpetualsCreateCsvRebatesBody {
        accountIds?: bigint[];
        aggregated?: boolean;
        calculationVariables: PerpetualsCalculationVariables;
        totalMakerRewards: number;
        totalTakerRewards: number;
    }

    Hierarchy (View Summary)

    Index
    accountIds? aggregated? calculationVariables totalMakerRewards totalTakerRewards
    accountIds?: bigint[]

    Optional account filter. Omit or pass an empty array for all eligible accounts.

    aggregated?: boolean

    When true, aggregate rewards by owner address instead of per-account. Defaults to false when omitted.

    calculationVariables: PerpetualsCalculationVariables

    Coefficients used to compute Q-scores and taker shares.

    totalMakerRewards: number

    Total maker reward pool to distribute among eligible market makers.

    totalTakerRewards: number

    Total taker reward pool to distribute among eligible takers.

    Settings
    Member Visibility

    On This Page
    Properties