Get a user's RewardKit profile

GET

reward-kit

curl --request GET \
  --url https://api-v2.boost.xyz/reward-kit

{
  "activeBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "type": "AllowListIncentive",
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "status": "active",
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>"
      }
    }
  ],
  "claimedBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "type": "AllowListIncentive",
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "status": "active",
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>"
      }
    }
  ],
  "claimableBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "type": "AllowListIncentive",
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "status": "active",
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>"
      }
    }
  ],
  "totalClaimedAmountUsd": 1,
  "totalClaimableAmountUsd": 1
}

Query Parameters

budgetAccount

string

Filter boosts by a specific budget account address

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

owner

string

Filter boosts by a specific owner address

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

chainId

integer | null

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

Required range: x >= 0

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

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

tokens

string

Retrieve rewards configured with specific token addresses

Example:

"chainId:tokenAddress,chainId:tokenAddress:collection,..."

creatorAddress

string

Filter rewards by a reward's creator address

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

claimantAddress

string

Show relevant rewards for this user's address

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

Response

200

application/json

Returns a user's RewardKit profile

Rewards and metadata that correspond to the RewardKit for a user's address

activeBoosts

object[]

required

An array of active RewardKit rewards that match a filter criteria, but are not yet claimable or claimed

A single RewardKit reward, with incentives, and additional configuration

activeBoosts.id

string

required

The reward identifier in the form of "chainId:boostCoreAddress:identifier"

Example:

"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"

activeBoosts.chainId

number

required

The chain id of the network where the reward is being offered

activeBoosts.incentives

object[]

required

The incentives that can be claimed as part of the reward

An individual incentive that can be offered as part of a reward

activeBoosts.incentives.type

enum<string>

required

Human readable label for the incentive type

Available options:

AllowListIncentive,

CGDAIncentive,

ERC20Incentive,

PointsIncentive,

ERC20VariableIncentive,

ERC20VariableCriteriaIncentive,

ERC20VariableCriteriaIncentiveV2,

ERC20PeggedIncentive,

ERC20PeggedVariableCriteriaIncentive,

ERC20PeggedVariableCriteriaIncentiveV2

activeBoosts.incentives.assetAddress

string

Address of the asset being rewarded

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

activeBoosts.incentives.rewardPercentage

number

For variable criteria incentives, the percent as a whole number (0-100) of the signed claim amount the claimant will receive

Example:

50

activeBoosts.incentives.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.

activeBoosts.incentives.rewardAmountFormatted

string

Formatted amount of reward tokens

activeBoosts.incentives.maxReward

string

Maximum amount of reward tokens that can be claimed

activeBoosts.incentives.rewardUsdValue

number

Approximate amount of USD that can be claimed

activeBoosts.incentives.tokenSymbol

string

The symbol of the token being rewarded, ie: USDC

activeBoosts.incentives.tokenImageUri

string

A url for the token image

activeBoosts.incentives.metadata

object | null

Additional metadata about the asset being rewarded

activeBoosts.actionTemplate

object | null

required

An object containing information about the action that must be taken to claim the reward

activeBoosts.status

enum<string>

The status of the reward, either active, claimable, or claimed

Available options:

active,

claimable,

claimed

activeBoosts.txHash

string

The transaction hash of the reward

activeBoosts.boostName

string | null

The status of the reward, either active, claimable, or claimed

activeBoosts.nftImageUri

string

The url of an image to present along with the reward

activeBoosts.nftName

string

The name of the NFT associated with the reward

activeBoosts.tokenImageUri

string

The url of an individual token to present along with the reward

activeBoosts.blockTimestamp

string

The block timestamp of the reward

claimedBoosts

object[]

required

An array of claimed RewardKit rewards that match a filter criteria

A single RewardKit reward, with incentives, and additional configuration

claimedBoosts.id

string

required

The reward identifier in the form of "chainId:boostCoreAddress:identifier"

Example:

"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"

claimedBoosts.chainId

number

required

The chain id of the network where the reward is being offered

claimedBoosts.incentives

object[]

required

The incentives that can be claimed as part of the reward

An individual incentive that can be offered as part of a reward

claimedBoosts.incentives.type

enum<string>

required

Human readable label for the incentive type

Available options:

AllowListIncentive,

CGDAIncentive,

ERC20Incentive,

PointsIncentive,

ERC20VariableIncentive,

ERC20VariableCriteriaIncentive,

ERC20VariableCriteriaIncentiveV2,

ERC20PeggedIncentive,

ERC20PeggedVariableCriteriaIncentive,

ERC20PeggedVariableCriteriaIncentiveV2

claimedBoosts.incentives.assetAddress

string

Address of the asset being rewarded

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

claimedBoosts.incentives.rewardPercentage

number

For variable criteria incentives, the percent as a whole number (0-100) of the signed claim amount the claimant will receive

Example:

50

claimedBoosts.incentives.rewardAmount

string

claimedBoosts.incentives.rewardAmountFormatted

string

Formatted amount of reward tokens

claimedBoosts.incentives.maxReward

string

Maximum amount of reward tokens that can be claimed

claimedBoosts.incentives.rewardUsdValue

number

Approximate amount of USD that can be claimed

claimedBoosts.incentives.tokenSymbol

string

The symbol of the token being rewarded, ie: USDC

claimedBoosts.incentives.tokenImageUri

string

A url for the token image

claimedBoosts.incentives.metadata

object | null

Additional metadata about the asset being rewarded

claimedBoosts.actionTemplate

object | null

required

An object containing information about the action that must be taken to claim the reward

claimedBoosts.status

enum<string>

The status of the reward, either active, claimable, or claimed

Available options:

active,

claimable,

claimed

claimedBoosts.txHash

string

The transaction hash of the reward

claimedBoosts.boostName

string | null

The status of the reward, either active, claimable, or claimed

claimedBoosts.nftImageUri

string

The url of an image to present along with the reward

claimedBoosts.nftName

string

The name of the NFT associated with the reward

claimedBoosts.tokenImageUri

string

The url of an individual token to present along with the reward

claimedBoosts.blockTimestamp

string

The block timestamp of the reward

claimableBoosts

object[]

required

An array of claimable RewardKit rewards that match a filter criteria

A single RewardKit reward, with incentives, and additional configuration

claimableBoosts.id

string

required

The reward identifier in the form of "chainId:boostCoreAddress:identifier"

Example:

"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"

claimableBoosts.chainId

number

required

The chain id of the network where the reward is being offered

claimableBoosts.incentives

object[]

required

The incentives that can be claimed as part of the reward

An individual incentive that can be offered as part of a reward

claimableBoosts.incentives.type

enum<string>

required

Human readable label for the incentive type

Available options:

AllowListIncentive,

CGDAIncentive,

ERC20Incentive,

PointsIncentive,

ERC20VariableIncentive,

ERC20VariableCriteriaIncentive,

ERC20VariableCriteriaIncentiveV2,

ERC20PeggedIncentive,

ERC20PeggedVariableCriteriaIncentive,

ERC20PeggedVariableCriteriaIncentiveV2

claimableBoosts.incentives.assetAddress

string

Address of the asset being rewarded

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

claimableBoosts.incentives.rewardPercentage

number

For variable criteria incentives, the percent as a whole number (0-100) of the signed claim amount the claimant will receive

Example:

50

claimableBoosts.incentives.rewardAmount

string

claimableBoosts.incentives.rewardAmountFormatted

string

Formatted amount of reward tokens

claimableBoosts.incentives.maxReward

string

Maximum amount of reward tokens that can be claimed

claimableBoosts.incentives.rewardUsdValue

number

Approximate amount of USD that can be claimed

claimableBoosts.incentives.tokenSymbol

string

The symbol of the token being rewarded, ie: USDC

claimableBoosts.incentives.tokenImageUri

string

A url for the token image

claimableBoosts.incentives.metadata

object | null

Additional metadata about the asset being rewarded

claimableBoosts.actionTemplate

object | null

required

An object containing information about the action that must be taken to claim the reward

claimableBoosts.status

enum<string>

The status of the reward, either active, claimable, or claimed

Available options:

active,

claimable,

claimed

claimableBoosts.txHash

string

The transaction hash of the reward

claimableBoosts.boostName

string | null

The status of the reward, either active, claimable, or claimed

claimableBoosts.nftImageUri

string

The url of an image to present along with the reward

claimableBoosts.nftName

string

The name of the NFT associated with the reward

claimableBoosts.tokenImageUri

string

The url of an individual token to present along with the reward

claimableBoosts.blockTimestamp

string

The block timestamp of the reward

totalClaimedAmountUsd

number

required

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

Required range: x >= 0

totalClaimableAmountUsd

number

required

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

Required range: x >= 0

Get a list of reward kit rewards Get a single RewardKit reward

curl --request GET \
  --url https://api-v2.boost.xyz/reward-kit

{
  "activeBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "type": "AllowListIncentive",
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "status": "active",
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>"
      }
    }
  ],
  "claimedBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "type": "AllowListIncentive",
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "status": "active",
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>"
      }
    }
  ],
  "claimableBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "type": "AllowListIncentive",
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "status": "active",
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>"
      }
    }
  ],
  "totalClaimedAmountUsd": 1,
  "totalClaimableAmountUsd": 1
}

RewardKit

Boost

API Reference

Query Parameters

Response