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>",
        "maxRewardUsdValue": 123,
        "rewardUsdValue": 123,
        "tokenSymbol": "<string>",
        "tokenImageUri": "<string>",
        "metadata": {
          "id": "<string>",
          "chainId": 123,
          "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "decimals": 123,
          "name": "<string>",
          "symbol": "<string>",
          "imageUri": "<string>"
        }
      }
    ],
    "actionTemplate": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "<string>",
      "actionType": "mint",
      "projectImage": "<string>",
      "description": "<string>"
    },
    "status": "active",
    "txHash": "<string>",
    "boostName": "<string>",
    "nftImageUri": "<string>",
    "nftName": "<string>",
    "tokenImageUri": "<string>",
    "blockTimestamp": "<string>",
    "projectUrl": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "claimCount": 1,
    "totalBudget": "<string>",
    "rewardsDistributed": "<string>",
    "signature": {
      "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "incentiveId": 1,
      "signature": "<string>",
      "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
    },
    "accessStatus": "allowed",
    "actionTokenMetadata": {
      "tokenSymbol": "<string>",
      "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "chainId": 123,
      "tokenImage": "<string>",
      "decimals": 123,
      "marketCap": 123,
      "priceChange24Hr": 123,
      "volume24Hr": 123,
      "priceUsd": 123,
      "holders": 123
    },
    "verificationLevel": "<string>",
    "usdDistributed24Hr": 12345.67
  },
  "totalClaims": 1,
  "claims": [
    {
      "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "txHash": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "active",
  "txHash": "<string>",
  "accessStatus": "allowed",
  "verificationLevel": "<string>"
}

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>",
        "maxRewardUsdValue": 123,
        "rewardUsdValue": 123,
        "tokenSymbol": "<string>",
        "tokenImageUri": "<string>",
        "metadata": {
          "id": "<string>",
          "chainId": 123,
          "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "decimals": 123,
          "name": "<string>",
          "symbol": "<string>",
          "imageUri": "<string>"
        }
      }
    ],
    "actionTemplate": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "<string>",
      "actionType": "mint",
      "projectImage": "<string>",
      "description": "<string>"
    },
    "status": "active",
    "txHash": "<string>",
    "boostName": "<string>",
    "nftImageUri": "<string>",
    "nftName": "<string>",
    "tokenImageUri": "<string>",
    "blockTimestamp": "<string>",
    "projectUrl": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "claimCount": 1,
    "totalBudget": "<string>",
    "rewardsDistributed": "<string>",
    "signature": {
      "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "incentiveId": 1,
      "signature": "<string>",
      "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
    },
    "accessStatus": "allowed",
    "actionTokenMetadata": {
      "tokenSymbol": "<string>",
      "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "chainId": 123,
      "tokenImage": "<string>",
      "decimals": 123,
      "marketCap": 123,
      "priceChange24Hr": 123,
      "volume24Hr": 123,
      "priceUsd": 123,
      "holders": 123
    },
    "verificationLevel": "<string>",
    "usdDistributed24Hr": 12345.67
  },
  "totalClaims": 1,
  "claims": [
    {
      "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "txHash": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "active",
  "txHash": "<string>",
  "accessStatus": "allowed",
  "verificationLevel": "<string>"
}

Path Parameters

string

required

BoostID in format chainId:boostCoreAddress:identifier The ID of the reward to fetch details for.

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"

includeTokenMetadata

boolean | null

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

Example:

true

Response

Returns single RewardKit reward

The response object for a single RewardKit reward.

boost

object

required

An object containing details about the reward.

Show child attributes

boost.id

string

required

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

Example:

"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"

boost.chainId

number

required

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

boost.incentives

object[]

required

The incentives that can be claimed as part of the reward

Show child attributes

boost.incentives.type

enum<string>

required

Human readable label for the incentive type

Available options:

AllowListIncentive,

CGDAIncentive,

ERC20Incentive,

PointsIncentive,

ERC20VariableIncentive,

ERC20VariableCriteriaIncentive,

ERC20VariableCriteriaIncentiveV2,

ERC20PeggedIncentive,

ERC20PeggedVariableCriteriaIncentive,

ERC20PeggedVariableCriteriaIncentiveV2

boost.incentives.assetAddress

string

Address of the asset being rewarded

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

boost.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

boost.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.

boost.incentives.rewardAmountFormatted

string

Formatted amount of reward tokens

boost.incentives.maxReward

string

Maximum amount of reward tokens that can be claimed

boost.incentives.maxRewardUsdValue

number

Approximate USD value of the maximum reward that can be claimed

boost.incentives.rewardUsdValue

number

Approximate amount of USD that can be claimed

boost.incentives.tokenSymbol

string

The symbol of the token being rewarded, ie: USDC

boost.incentives.tokenImageUri

string

A url for the token image

boost.incentives.metadata

object

Additional metadata about the asset being rewarded

Show child attributes

boost.incentives.metadata.id

string

required

The system ID of the token

boost.incentives.metadata.chainId

number

required

The chain ID where this token is deployed

boost.incentives.metadata.address

string

required

The address of the token

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

boost.incentives.metadata.decimals

number

required

The number of decimal places for the token, typically 18

boost.incentives.metadata.name

string

required

The display name for the token

boost.incentives.metadata.symbol

string

required

The token's symbol, "DEGEN" for example

boost.incentives.metadata.imageUri

string

required

A URI pointing to an image representing the token

boost.actionTemplate

object

required

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

Show child attributes

boost.actionTemplate.id

string<uuid>

required

The action template's system id

boost.actionTemplate.projectId

string

required

Human readable project name the action is designed for, eg. "zora"

boost.actionTemplate.actionType

string

required

Readable system type describing the type of action that must be taken to claim the reward, eg: "mint", "create-any-token"

Example:

"mint"

boost.actionTemplate.projectImage

string

required

A url for this action template's project image

boost.actionTemplate.description

string | null

A description of the action that must be taken to claim the reward

boost.status

enum<string>

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

Available options:

active,

claimed,

claimable

boost.txHash

string

The transaction hash of the reward

boost.boostName

string | null

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

boost.nftImageUri

string

The url of an image to present along with the reward

boost.nftName

string

The name of the NFT associated with the reward

boost.tokenImageUri

string

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

boost.blockTimestamp

string

The block timestamp of the reward

boost.projectUrl

string<uri>

The URL where users can view or interact with this reward's associated project

boost.startTime

string<date-time> | null

Start time of a boost

boost.endTime

string<date-time> | null

End time of a boost

boost.claimCount

integer

The total number of claims for this reward

Required range: x >= 0

boost.totalBudget

string

The total budget allocated for this reward across all incentives, in the reward token's smallest unit

boost.rewardsDistributed

string

The total amount of rewards distributed for this reward, in the reward token's smallest unit

boost.signature

object

The claim signature for the reward

Show child attributes

boost.signature.claimant

string

required

Ethereum address

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

boost.signature.incentiveId

integer

required

Required range: x >= 0

boost.signature.signature

string

required

boost.signature.referrer

string

required

Ethereum address

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

boost.accessStatus

enum<string> | null

Determines the access status of the boost for a given address

Available options:

allowed,

denied,

not-allowed

boost.actionTokenMetadata

object

Metadata for tokens, including price and market data

Show child attributes

boost.actionTokenMetadata.tokenSymbol

string

required

The symbol of the token being swapped, e.g., "DEGEN"

boost.actionTokenMetadata.tokenContract

string

required

The contract address of the token

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

boost.actionTokenMetadata.chainId

number

required

The chain ID where the token exists

boost.actionTokenMetadata.tokenImage

string<uri>

URL for the token image

boost.actionTokenMetadata.decimals

number

The number of decimals for the token

boost.actionTokenMetadata.marketCap

number

Market capitalization in USD

boost.actionTokenMetadata.priceChange24Hr

number

Price change percentage in the last 24 hours

boost.actionTokenMetadata.volume24Hr

number

Trading volume in USD for the last 24 hours

boost.actionTokenMetadata.priceUsd

number

Current price in USD

boost.actionTokenMetadata.holders

number

Number of token holders

boost.verificationLevel

string | null

Verification level required for boosts in the World ecosystem

boost.usdDistributed24Hr

number

Volume in USD for the last 24 hours

Required range: x >= 0

Example:

12345.67

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.

Show child attributes

claims.address

string

required

The address of the user who claimed the reward.

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

claims.txHash

string

required

The transaction hash of the claim transaction.

claims.timestamp

string<date-time>

required

The timestamp of the claim transaction.

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.

accessStatus

enum<string> | null

Determines the access status of the boost for a given address

Available options:

allowed,

denied,

not-allowed

verificationLevel

string | null

Verification level required for boosts in the World ecosystem

Get a user's RewardKit profile Get all Action Templates

⌘I

Boost

RewardKit

Action

Contract

API Reference

Path Parameters

Query Parameters

Response