aftermath-ts-sdk - v6.1.0
    Preparing search index...

    Interface ApiPerpetualsCreateCsvRebatesBody

    Request body for generating a CSV-formatted rebate report.

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

    The same inputs as ApiRewardsDistributionBody, plus aggregated. When accountIds is omitted or empty, all eligible accounts are included.

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

    Hierarchy (View Summary)

    Index
    accountIds?: bigint[]

    Optional account filter. Omit or pass an empty array for all eligible accounts. Caller serializes each id to the API's "123n" wire format and parses the response back, so pass real bigints here.

    aggregated?: boolean

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

    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.