Skip to content

Get Rewards Aggregated

Retrieves aggregated historical trading rewards for the specified address.

Method Declaration

Python
async def get_historical_trading_rewards_aggregated(
    self,
    address: str,
    period: TradingRewardAggregationPeriod = TradingRewardAggregationPeriod.DAILY,
    limit: Optional[int] = None,
    starting_before_or_at: Optional[str] = None,
    starting_before_or_at_height: Optional[int] = None,
) -> Any

Parameters

ParameterLocationTypeRequiredDescription
addresspathAddresstrueThe wallet address that owns the account.
periodqueryTradingRewardAggregationPeriodtrueThe aggregation period.
limitqueryu32falseThe maximum number of aggregated rewards to retrieve.
startingBeforeOrAtqueryDateTimefalseThe timestamp filter for rewards starting before or at.
startingBeforeOrAtHeightqueryHeightfalseThe block height filter for rewards starting before or at.

Response

StatusMeaningSchemaDescription
200OKHistoricalTradingRewardAggregation ⛁The aggregated historical trading rewards data.
400Bad RequestThe request was malformed or invalid.
API Example