GET
/
reward-kit
/
boosts
/
:id
Get a single RewardKit reward
curl --request GET \
  --url https://api-v2.boost.xyz/reward-kit/boosts/:id
{
  "boost": {
    "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>",
    "projectUrl": "<string>",
    "actionTemplate": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "<string>",
      "actionType": "mint",
      "projectImage": "<string>"
    }
  },
  "totalClaims": 1,
  "claims": [
    {
      "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "txHash": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "active",
  "txHash": "<string>"
}

Path Parameters

​
id
string
required

BoostID in format chainId:boostCoreAddress:identifier

Example:

"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"

Query Parameters

​
address
string

If included, the address of a specific claimant to enrich data with claim information, like claimed, claimable, and tx hash for eligible claim.

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

Response

Returns single RewardKit reward

The response object for a single RewardKit reward.

​
boost
object
required

An object containing details about the reward.

​
totalClaims
integer
required

The total number of claims for this reward.

Required range: x >= 0
​
claims
object[]
required

An array of user claims for this reward.

​
status
enum<string>
required

The state of the reward, either active, claimed, or claimable. Where active is when the reward is still eligible to be completed, claimed is when user has claimed the reward, and claimable is when the user has completed the required action and is eligible to claim.

Available options:
active,
claimed,
claimable
​
txHash
string

If address was provided, and the user has completed the reward action, the transaction hash of the claim transaction.