RewardKit
Boost
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>",
"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>",
"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>",
"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
An array of active RewardKit rewards that match a filter criteria, but are not yet claimable or claimed
A single RewardKit reward, with incentives, and additional configuration
The reward identifier in the form of "chainId:boostCoreAddress:identifier"
"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"
The chain id of the network where the reward is being offered
The incentives that can be claimed as part of the reward
An individual incentive that can be offered as part of a reward
Human readable label for the incentive type
AllowListIncentive
, CGDAIncentive
, ERC20Incentive
, PointsIncentive
, ERC20VariableIncentive
, ERC20VariableCriteriaIncentive
, ERC20VariableCriteriaIncentiveV2
, ERC20PeggedIncentive
, ERC20PeggedVariableCriteriaIncentive
, ERC20PeggedVariableCriteriaIncentiveV2
Address of the asset being rewarded
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
For variable criteria incentives, the percent as a whole number (0-100) of the signed claim amount the claimant will receive
50
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.
Formatted amount of reward tokens
Maximum amount of reward tokens that can be claimed
Approximate amount of USD that can be claimed
The symbol of the token being rewarded, ie: USDC
A url for the token image
Additional metadata about the asset being rewarded
The system ID of the token
The chain ID where this token is deployed
The address of the token
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
The number of decimal places for the token, typically 18
The display name for the token
The token's symbol, "DEGEN" for example
A URI pointing to an image representing the token
An object containing information about the action that must be taken to claim the reward
The action template's system id
Human readable project name the action is designed for, eg. "zora"
Readable system type describing the type of action that must be taken to claim the reward, eg: "mint", "create-any-token"
"mint"
A url for this action template's project image
The status of the reward, either active, claimable, or claimed
active
, claimable
, claimed
The transaction hash of the reward
The status of the reward, either active, claimable, or claimed
The url of an image to present along with the reward
The name of the NFT associated with the reward
The url of an individual token to present along with the reward
The block timestamp of the reward
An array of claimed RewardKit rewards that match a filter criteria
A single RewardKit reward, with incentives, and additional configuration
The reward identifier in the form of "chainId:boostCoreAddress:identifier"
"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"
The chain id of the network where the reward is being offered
The incentives that can be claimed as part of the reward
An individual incentive that can be offered as part of a reward
Human readable label for the incentive type
AllowListIncentive
, CGDAIncentive
, ERC20Incentive
, PointsIncentive
, ERC20VariableIncentive
, ERC20VariableCriteriaIncentive
, ERC20VariableCriteriaIncentiveV2
, ERC20PeggedIncentive
, ERC20PeggedVariableCriteriaIncentive
, ERC20PeggedVariableCriteriaIncentiveV2
Address of the asset being rewarded
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
For variable criteria incentives, the percent as a whole number (0-100) of the signed claim amount the claimant will receive
50
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.
Formatted amount of reward tokens
Maximum amount of reward tokens that can be claimed
Approximate amount of USD that can be claimed
The symbol of the token being rewarded, ie: USDC
A url for the token image
Additional metadata about the asset being rewarded
The system ID of the token
The chain ID where this token is deployed
The address of the token
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
The number of decimal places for the token, typically 18
The display name for the token
The token's symbol, "DEGEN" for example
A URI pointing to an image representing the token
An object containing information about the action that must be taken to claim the reward
The action template's system id
Human readable project name the action is designed for, eg. "zora"
Readable system type describing the type of action that must be taken to claim the reward, eg: "mint", "create-any-token"
"mint"
A url for this action template's project image
The status of the reward, either active, claimable, or claimed
active
, claimable
, claimed
The transaction hash of the reward
The status of the reward, either active, claimable, or claimed
The url of an image to present along with the reward
The name of the NFT associated with the reward
The url of an individual token to present along with the reward
The block timestamp of the reward
An array of claimable RewardKit rewards that match a filter criteria
A single RewardKit reward, with incentives, and additional configuration
The reward identifier in the form of "chainId:boostCoreAddress:identifier"
"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"
The chain id of the network where the reward is being offered
The incentives that can be claimed as part of the reward
An individual incentive that can be offered as part of a reward
Human readable label for the incentive type
AllowListIncentive
, CGDAIncentive
, ERC20Incentive
, PointsIncentive
, ERC20VariableIncentive
, ERC20VariableCriteriaIncentive
, ERC20VariableCriteriaIncentiveV2
, ERC20PeggedIncentive
, ERC20PeggedVariableCriteriaIncentive
, ERC20PeggedVariableCriteriaIncentiveV2
Address of the asset being rewarded
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
For variable criteria incentives, the percent as a whole number (0-100) of the signed claim amount the claimant will receive
50
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.
Formatted amount of reward tokens
Maximum amount of reward tokens that can be claimed
Approximate amount of USD that can be claimed
The symbol of the token being rewarded, ie: USDC
A url for the token image
Additional metadata about the asset being rewarded
The system ID of the token
The chain ID where this token is deployed
The address of the token
"0x378632819f39c74c4f56b1429e760739c5fb51b7"
The number of decimal places for the token, typically 18
The display name for the token
The token's symbol, "DEGEN" for example
A URI pointing to an image representing the token
An object containing information about the action that must be taken to claim the reward
The action template's system id
Human readable project name the action is designed for, eg. "zora"
Readable system type describing the type of action that must be taken to claim the reward, eg: "mint", "create-any-token"
"mint"
A url for this action template's project image
The status of the reward, either active, claimable, or claimed
active
, claimable
, claimed
The transaction hash of the reward
The status of the reward, either active, claimable, or claimed
The url of an image to present along with the reward
The name of the NFT associated with the reward
The url of an individual token to present along with the reward
The block timestamp of the reward
The total amount of USD claimed by the user via rewards that match a filter criteria
x >= 0
The total amount of USD claimable by the user via rewards that match a filter criteria
x >= 0
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>",
"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>",
"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>",
"actionTemplate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "<string>",
"actionType": "mint",
"projectImage": "<string>"
}
}
],
"totalClaimedAmountUsd": 1,
"totalClaimableAmountUsd": 1
}