GET
/
boosts
/
:id
curl --request GET \
  --url https://api-v2.boost.xyz/boosts/:id
{
  "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
  "actionSteps": [
    {
      "chainId": 123,
      "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "signature": "<string>",
      "signatureName": "<string>",
      "signatureType": "event",
      "actionType": 123,
      "targetContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "parameters": {
        "filterType": 123,
        "fieldType": 123,
        "fieldIndex": 123,
        "filterData": "<string>"
      }
    }
  ],
  "actionClaimant": {
    "signature": "<string>",
    "signatureName": "<string>",
    "signatureType": "event",
    "fieldIndex": 123,
    "targetContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "targetContractName": "<string>",
    "chainId": 123
  },
  "allowList": {
    "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "contractAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "type": "SimpleAllowList",
    "addresses": [
      "0x378632819f39c74c4f56b1429e760739c5fb51b7"
    ]
  },
  "protocolFee": "<string>",
  "maxParticipants": "<string>",
  "incentives": [
    {
      "type": "AllowListIncentive",
      "allowListAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "limit": "<string>"
    }
  ],
  "createdAtBlockchainNumbers": {},
  "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
  "isActive": true,
  "createdAt": "<string>",
  "availableBudgetUsd": "<string>",
  "budget": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
  "templateId": "<string>",
  "nftImageUri": "<string>",
  "nftName": "<string>",
  "boostName": "<string>",
  "nftMetadataId": "<string>",
  "projectImageUri": "<string>",
  "tokenImageUri": "<string>"
}

Path Parameters

id
string
required

BoostID in format chainId:boostCoreAddress:identifier

Example:

"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"

Response

200
application/json
Returns a list of Boosts
id
string
required

The reward's ID

Example:

"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"

actionSteps
object[]
required

An array of the reward's action steps, the actions required for a user to claim

allowList
object
required

An object specifying configuration for who can claim

protocolFee
string
required

The reward protocol fee, if any

maxParticipants
string
required

The maximum number of users that can claim a reward

incentives
object[]
required

An array of rewards that can be claimed

An incentive that when claimed, adds the claimant's address to a Boost Protocol AllowList.

owner
string
required

The address of this reward's owner

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

isActive
boolean
required

Is the reward still eligible to be claimed

createdAt
string
required

The date and time when this Boost was created

budget
string
required

Address of the Boost's funding budget account

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

actionClaimant
object | null

An object containing information on how to extract a claimant address from a valid action transaction

createdAtBlockchainNumbers
object | null

The block number when this reward was created

availableBudgetUsd
string | null

The available budget in USD for this Boost

templateId
string | null

System ID for the action template, which describes the action that needs to be taken to be eligible for a claim

nftImageUri
string | null

URI of an image for the reward NFT

nftName
string | null

Name of the NFT, if applicable

boostName
string | null

Human readable name describing the Boost, typically the action that needs to be taken to be eligible for a claim

nftMetadataId
string | null

System ID for the reward NFT metadata, if it exists

projectImageUri
string | null

URI of an image for the reward token

tokenImageUri
string | null

URI of an image for the token