--- title: "Get trending rewards" method: GET path: "/reward-kit/trending" tags: ["RewardKitTrending"] --- # Get trending rewards `GET /reward-kit/trending` Returns a list of boosts that are trending based on the volume in the specified time period (1h or 24h). ## Query parameters - `budgetAccount` string — Filter boosts by budget account address(es). Accepts a single address or comma-separated list of addresses - `owner` string — Filter boosts by a specific owner address - `autoboostId` string — Filter boosts by a specific autoboost ID - `chainId` integer, nullable — Only retrieve Boosts for a specific chain ID. You must supply this parameter if also specifying `targetContract` - `targetContract` string — Retrieve rewards configured with actions that target a specific contract i.e., Zora's address for all rewards that require a mint in order to claim a reward. If you supply this parameter, you must also supply chainId - `tokens` string — Retrieve rewards configured with specific token addresses - `distributionChannel` string — Filter boosts by comma separated list of distribution channels - `sortBy` '1h' | '24h' — Sort trending boosts by volume in the specified time period - `tokenWhitelist` boolean, nullable — Filter boosts by token whitelist - `creatorAddress` string — Filter rewards by a reward's creator address - `claimantAddress` string, required — Show relevant rewards for this user's address - `actionType` string — Filter by the type of actions that must be taken to claim the reward, eg: "mint", "swap" - `excludeActionType` string — Exclude rewards with these action types, eg: "mint", "swap" - `includeTokenMetadata` boolean, nullable — Include token metadata (price, market cap, etc.) for swap actions. Defaults to false. ## Response `200` Returns a user's RewardKit profile - object — Trending rewards and metadata that correspond to the RewardKit for a user's address - `trendingBoosts` object[], required — An array of active RewardKit rewards that are trending - `id` string, required — The reward identifier in the form of "chainId:boostCoreAddress:identifier" - `chainId` number, required — The chain id of the network where the reward is being offered - `incentives` object[], required — The incentives that can be claimed as part of the reward - `type` 'AllowListIncentive' | 'CGDAIncentive' | 'ERC20Incentive' | 'PointsIncentive' | 'ERC20VariableIncentive' | 'ERC20VariableCriteriaIncentive' | 'ERC20VariableCriteriaIncentiveV2' | 'ERC20PeggedIncentive' | 'ERC20PeggedVariableCriteriaIncentive' | 'ERC20PeggedVariableCriteriaIncentiveV2', required — Human readable label for the incentive type - `assetAddress` string — Address of the asset being rewarded - `rewardPercentage` number — For variable criteria incentives, the percent as a whole number (0-100) of the signed claim amount the claimant will receive - `rebatePercentage` number — Alias for rewardPercentage (for v2 parity). For variable criteria incentives, the rebate percentage as a whole number. Deprecated: use rewardPercentage instead. - `rewardAmount` string — For variable criteria incentives, the maximum amount that can be claimed in a single transaction. Otherwise, the fixed reward value. If reward is queried with a claimant address, and the user has performed the requisite claim action, and reward is in a claimable state, this will be the claimable amount. - `rewardAmountFormatted` string — Formatted amount of reward tokens - `maxReward` string — Maximum amount of reward tokens that can be claimed - `maxRewardUsdValue` number — Approximate USD value of the maximum reward that can be claimed - `rewardUsdValue` number — Approximate amount of USD that can be claimed - `tokenSymbol` string — The symbol of the token being rewarded, ie: USDC - `tokenImageUri` string — A url for the token image - `metadata` object, nullable — Additional metadata about the asset being rewarded - `id` string, required — The system ID of the token - `chainId` number, required — The chain ID where this token is deployed - `address` string, required — The address of the token - `decimals` number, required — The number of decimal places for the token, typically 18 - `name` string, required — The display name for the token - `symbol` string, required — The token's symbol, "DEGEN" for example - `imageUri` string, required — A URI pointing to an image representing the token - `status` 'active' | 'claimed' | 'claimable' — The status of the reward, either active, claimable, or claimed - `txHash` string — The transaction hash of the reward - `boostName` string, nullable — The status of the reward, either active, claimable, or claimed - `nftImageUri` string — The url of an image to present along with the reward - `nftName` string — The name of the NFT associated with the reward - `tokenImageUri` string — The url of an individual token to present along with the reward - `blockTimestamp` string — The block timestamp of the reward - `projectUrl` string, uri — The URL where users can view or interact with this reward's associated project - `actionTemplate` object, nullable, required — An object containing information about the action that must be taken to claim the reward - `id` string, uuid, required — The action template's system id - `projectId` string, required — Human readable project name the action is designed for, eg. "zora" - `actionType` string, required — Readable system type describing the type of action that must be taken to claim the reward, eg: "mint", "create-any-token" - `projectImage` string, required — A url for this action template's project image - `description` string, nullable — A description of the action that must be taken to claim the reward - `category` 'defi' | 'nft' | 'gaming' | 'social' | 'bridge' | 'governance' | 'payments' | 'other', nullable — The category of the boost action, eg: "defi", "nft", "gaming" - `startTime` string, date-time, nullable — Start time of a boost - `endTime` string, date-time, nullable — End time of a boost - `claimCount` integer — The total number of claims for this reward - `totalBudget` string — The total budget allocated for this reward across all incentives, in the reward token's smallest unit - `rewardsDistributed` string — The total amount of rewards distributed for this reward, in the reward token's smallest unit - `signature` object, nullable — The claim signature for the reward - `claimant` string, required — Ethereum address - `incentiveId` integer, required - `signature` string, required - `referrer` string, required — Ethereum address - `accessStatus` 'allowed' | 'denied' | 'not-allowed', nullable — Determines the access status of the boost for a given address - `actionTokenMetadata` object — Metadata for tokens, including price and market data - `tokenSymbol` string, required — The symbol of the token being swapped, e.g., "DEGEN" - `tokenContract` string, required — The contract address of the token - `tokenImage` string, uri — URL for the token image - `chainId` number, required — The chain ID where the token exists - `decimals` number — The number of decimals for the token - `marketCap` number — Market capitalization in USD - `priceChange24Hr` number — Price change percentage in the last 24 hours - `volume24Hr` number — Trading volume in USD for the last 24 hours - `priceUsd` number — Current price in USD - `holders` number — Number of token holders - `verificationLevel` string, nullable — Verification level required for boosts in the World ecosystem - `usdDistributed24Hr` number — Volume in USD for the last 24 hours - `usdDistributed1Hr` number — Volume in USD for the last hour ## Other responses - `400` — Validation failed --- [API](https://skmtc.dev/boost/apis/boost-v2-api.md) · [All operations](https://skmtc.dev/boost/apis/boost-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/boost/boost-v2-api/revisions/23f55c70a429/schema)