Boost
Get details for a Boost
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
Boost
Get details for a Boost
Return detailed information about a Boost, including budget, allowlist, incentives, actions, and token metadata
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>",
"actionTemplateId": "<string>",
"nftImageUri": "<string>",
"nftName": "<string>",
"boostName": "<string>",
"nftMetadataId": "<string>",
"projectImageUri": "<string>",
"tokenImageUri": "<string>"
}
Path Parameters
BoostID in format chainId:boostCoreAddress:identifier
Example:
"8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1"
Response
200
application/json
Returns a list of Boosts
The response is of type object
.
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>",
"actionTemplateId": "<string>",
"nftImageUri": "<string>",
"nftName": "<string>",
"boostName": "<string>",
"nftMetadataId": "<string>",
"projectImageUri": "<string>",
"tokenImageUri": "<string>"
}