BOboost
Boost

Get details for a Boost

Changed on

Return detailed information about a Boost, including budget, allowlist, incentives, actions, and token metadata

get/boosts/:id

Request

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

Path parameters

idstring required

The ID of the reward to retrieve details for

Example:8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1

BoostID in format chainId:boostCoreAddress:identifier

Response

Returns a list of Boosts

idstring required

The reward's ID

protocolFeestring required

The reward protocol fee, if any

maxParticipantsstring required

The maximum number of users that can claim a reward

createdAtBlockchainNumbersobject nullable

The block number when this reward was created

ownerstring required

The address of this reward's owner

isActiveboolean required

Is the reward still eligible to be claimed

createdAtstring required

The date and time when this Boost was created

availableBudgetUsdstring nullable

The available budget in USD for this Boost

budgetstring required

Address of the Boost's funding budget account

templateIdstring nullable

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

actionTemplateIdstring nullable

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

nftImageUristring nullable

URI of an image for the reward NFT

nftNamestring nullable

Name of the NFT, if applicable

boostNamestring nullable

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

nftMetadataIdstring nullable

System ID for the reward NFT metadata, if it exists

projectImageUristring nullable

URI of an image for the reward token

tokenImageUristring nullable

URI of an image for the token

startTimestring date-time nullable

Start time of a boost

endTimestring date-time nullable

End time of a boost

Example response

{
  "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
  "actionSteps": [
    {
      "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "targetContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
    }
  ],
  "actionClaimant": {
    "targetContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
  },
  "allowList": {
    "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "contractAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "addresses": [
      "0x378632819f39c74c4f56b1429e760739c5fb51b7"
    ]
  },
  "incentives": [
    {
      "allowListAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
    }
  ],
  "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
  "budget": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
}

Changes

  • 3f98a3931058Revision changes
    • breaking

      added subschema #6 subschema #7 subschema #9 subschema #10 to the / response property oneOf list for the response status

    • warning

      added the new OffchainAccessList enum value to the / response property for the response 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

      removed subschema #6 subschema #7 subschema #9 subschema #10 from the / response property oneOf list for the response status

  • 2b7b8b35aa45Revision changes
    • breaking

      api path removed without deprecation

    • info

      endpoint added