Boost
- GETFind event and function signatures used in Boost configurations
- GETGenerate a claim signature that can be used to submit a claim
- GETExplore contracts with Boosts
- GETGet a list of Boosts
- GETGet events for a specific Boost
- GETGet details for a Boost
- GETRetrieve a single Budget by its system ID
- GETGet Budgets
RewardKit
Contract
API Reference
Get a user's RewardKit profile
Accepts pagination, and filter options to return a list of active, claimable, and unclaimed rewards for a given user.
curl --request GET \
--url https://api-v2.boost.xyz/reward-kit
{
"activeBoosts": [
{
"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>"
}
}
],
"claimedBoosts": [
{
"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>"
}
}
],
"claimableBoosts": [
{
"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>"
}
}
],
"totalClaimedAmountUsd": 1,
"totalClaimableAmountUsd": 1
}
Query Parameters
Filter boosts by a specific budget account address
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
Filter boosts by a specific owner address
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
Only retrieve Boosts for a specific chain ID. You must supply this parameter if also specifying targetContract
x >= 0
Retrieve rewards configured with actions that target a specific contract i.e., Zora's address for all rewards that require a mint in order to claim a reward. If you supply this parameter, you must also supply chainId
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
Retrieve rewards configured with specific token addresses
"chainId:tokenAddress,chainId:tokenAddress:collection,..."
Filter rewards by a reward's creator address
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
Show relevant rewards for this user's address
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
Response
Rewards and metadata that correspond to the RewardKit for a user's address
curl --request GET \
--url https://api-v2.boost.xyz/reward-kit
{
"activeBoosts": [
{
"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>"
}
}
],
"claimedBoosts": [
{
"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>"
}
}
],
"claimableBoosts": [
{
"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>"
}
}
],
"totalClaimedAmountUsd": 1,
"totalClaimableAmountUsd": 1
}