v2

latestOpenAPI 3.1.02026-08-01170225.5 KB

RewardKit

Get a user's RewardKit profile

Returns a list of active, claimable, and unclaimed rewards for a given user.

get/reward-kit

Query parameters

budgetAccountstring

Filter boosts by budget account address(es). Accepts a single address or comma-separated list of addresses

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7,0x1234567890123456789012345678901234567890

ownerstring

Filter boosts by a specific owner address

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7

autoboostIdstring

Filter boosts by a specific autoboost ID

chainIdinteger nullable

Only retrieve Boosts for a specific chain ID. You must supply this parameter if also specifying targetContract

targetContractstring

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

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7

tokensstring

Retrieve rewards configured with specific token addresses

Example:chainId:tokenAddress,chainId:tokenAddress:collection,...

distributionChannelstring

Filter boosts by comma separated list of distribution channels

Example:distributionChannel=public,farcaster

sortBy'active' | 'recently-deployed'

Sort by active or recently deployed

tokenWhitelistboolean nullable

Filter boosts by token whitelist

creatorAddressstring

Filter rewards by a reward's creator address

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7

claimantAddressstring required

Show relevant rewards for this user's address

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7

actionTypestring

Filter by the type of actions that must be taken to claim the reward, eg: "mint", "swap"

Example:swap,mint

excludeActionTypestring

Exclude rewards with these action types, eg: "mint", "swap"

Example:mint,create-any-token

includeTokenMetadataboolean nullable

Include token metadata (price, market cap, etc.) for swap actions. Defaults to false.

Example:true

Response

Returns a user's RewardKit profile

totalClaimedAmountUsdnumber required

The total amount of USD claimed by the user via rewards that match a filter criteria

totalClaimableAmountUsdnumber required

The total amount of USD claimable by the user via rewards that match a filter criteria

Example response

{
  "activeBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "metadata": {
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
          }
        }
      ],
      "actionTemplate": {
        "actionType": "mint",
        "category": "defi"
      },
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ],
  "claimedBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "metadata": {
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
          }
        }
      ],
      "actionTemplate": {
        "actionType": "mint",
        "category": "defi"
      },
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ],
  "claimableBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "metadata": {
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
          }
        }
      ],
      "actionTemplate": {
        "actionType": "mint",
        "category": "defi"
      },
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ]
}