BOboost
RewardKit

Get a single RewardKit reward

Changed on

Retrieve details on a reward, optionally providing a claimant address to decorate with additional claim context.

get/reward-kit/boosts/:id

Request

  • Base URL
    https://api-v2.boost.xyz
  • Auth
    none declared

Path parameters

idstring required

The ID of the reward to fetch details for.

Example:8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1

BoostID in format chainId:boostCoreAddress:identifier

Query parameters

addressstring

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
includeTokenMetadataboolean nullable

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

Example:true

Response

Returns single RewardKit reward

totalClaimsinteger required

The total number of claims for this reward.

status'active' | 'claimed' | 'claimable' 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.

txHashstring

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

accessStatus'allowed' | 'denied' | 'not-allowed' nullable

Determines the access status of the boost for a given address

verificationLevelstring nullable

Verification level required for boosts in the World ecosystem

Example response

{
  "boost": {
    "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
  },
  "claims": [
    {
      "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
    }
  ]
}

Changes

  • 3f98a3931058Revision changes
    • info

      added the new optional query request parameter includeTokenMetadata

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

  • 2b7b8b35aa45Revision changes
    • info

      endpoint added