boosts
boost details
manager
metrics
accesslists
boosts
users
- GETuser profile
- GETuser details
- PUTupdate profile
- GETETH earned by user
- PUTupdate notification preferences
- GETfarcaster profile
- GETfarcaster verification status
- POSTadd neynar connection
- DELremove neynar connection
- POSTadd twitter connection
- DELdelete twitter connection
- GETUser notifications
- POSTRead notifications
- GETuser rewards
- GETprotocol rewards summary
- GETprotocol rewards earnings
- GETreferrals summary
- GETreferrals earnings
- GETreferrals feed
- GETtotal referral earnings
- GETreferrals activity feed
- GETactive/completed boosts referrals feed
boosts
boost details
Get boost details for a specific boostId, optionally including an address to retrieve user-specific boost details
GET
/
boosts
/
{boostId}
curl --request GET \
--url https://api-staging.boost.xyz/boosts/{boostId}
{
"id": "<string>",
"appLink": "<string>",
"contractAddress": "<string>",
"iconOption": "<string>",
"imagePath": "<string>",
"instructionsUrl": "<string>",
"name": "<string>",
"network": "<string>",
"queued": true,
"disabled": true,
"boostEnd": "<string>",
"boostStart": "<string>",
"completions24h": 123,
"completions7d": 123,
"completions30d": 123,
"completionsAll": 123,
"description": "<string>",
"status": "<string>",
"eligibility": {
"eligible": true
},
"reward": {
"type": "<string>",
"totalAllocated": 123,
"tokenSymbol": "<string>",
"amount": "<string>",
"token": "<string>",
"tokenContractAddress": "<string>",
"boostId": "<string>",
"tokenId": "<string>",
"network": {
"name": "<string>",
"chainId": "<string>"
},
"nftMedia": "<string>"
},
"task": {
"name": "<string>",
"abi": [
{}
],
"project": "<string>",
"displayId": "<string>",
"description": "<string>",
"link": "<string>",
"iconOption": "<string>",
"deprecated": true,
"contractAddress": "<string>",
"eventName": "<string>",
"status": "<string>",
"network": {
"name": "<string>",
"chainId": "<string>"
}
},
"tasks": [
{
"name": "<string>",
"abi": [
{}
],
"project": "<string>",
"displayId": "<string>",
"description": "<string>",
"link": "<string>",
"iconOption": "<string>",
"deprecated": true,
"contractAddress": "<string>",
"eventName": "<string>",
"status": "<string>",
"network": {
"name": "<string>",
"chainId": "<string>"
}
}
],
"creatorAddress": "<string>",
"filters": [
{
"name": "<string>",
"value": "<string>",
"operator": "<string>"
}
],
"abiInputFilters": [
{
"functionName": "<string>",
"name": "<string>",
"value": "<string>",
"operator": "<string>"
}
],
"boostAddress": "<string>",
"totalParticipants": 123,
"numberMinted": 123,
"participants": [
{
"account": "<string>",
"amount": "<string>"
}
],
"boostFactoryAddress": "<string>",
"receiptsMinted": 123,
"isReceiptEnabled": true,
"actionParams": {
"type": "bridge",
"data": {
"destinationNetworkId": "<string>",
"sourceChainId": 123,
"destinationChainId": 123,
"tokenAddress": "<string>",
"tokenDecimals": 123,
"amount": "<string>",
"amountOperator": "any"
}
},
"boostAttributes": [
"<string>"
],
"isPublic": true,
"metadata": {
"image": "<string>",
"postType": "<string>",
"profileName": "<string>"
},
"fees": {
"projectFee": "<string>",
"actionFee": "<string>"
}
}
Path Parameters
Query Parameters
Response
200
application/json
Success
DEPRECATED -- use "task" instead; "tasks" is always an array of length 1
Available options:
bridge
Available options:
any
, gt
, gte
, lt
, lte
, eq
curl --request GET \
--url https://api-staging.boost.xyz/boosts/{boostId}
{
"id": "<string>",
"appLink": "<string>",
"contractAddress": "<string>",
"iconOption": "<string>",
"imagePath": "<string>",
"instructionsUrl": "<string>",
"name": "<string>",
"network": "<string>",
"queued": true,
"disabled": true,
"boostEnd": "<string>",
"boostStart": "<string>",
"completions24h": 123,
"completions7d": 123,
"completions30d": 123,
"completionsAll": 123,
"description": "<string>",
"status": "<string>",
"eligibility": {
"eligible": true
},
"reward": {
"type": "<string>",
"totalAllocated": 123,
"tokenSymbol": "<string>",
"amount": "<string>",
"token": "<string>",
"tokenContractAddress": "<string>",
"boostId": "<string>",
"tokenId": "<string>",
"network": {
"name": "<string>",
"chainId": "<string>"
},
"nftMedia": "<string>"
},
"task": {
"name": "<string>",
"abi": [
{}
],
"project": "<string>",
"displayId": "<string>",
"description": "<string>",
"link": "<string>",
"iconOption": "<string>",
"deprecated": true,
"contractAddress": "<string>",
"eventName": "<string>",
"status": "<string>",
"network": {
"name": "<string>",
"chainId": "<string>"
}
},
"tasks": [
{
"name": "<string>",
"abi": [
{}
],
"project": "<string>",
"displayId": "<string>",
"description": "<string>",
"link": "<string>",
"iconOption": "<string>",
"deprecated": true,
"contractAddress": "<string>",
"eventName": "<string>",
"status": "<string>",
"network": {
"name": "<string>",
"chainId": "<string>"
}
}
],
"creatorAddress": "<string>",
"filters": [
{
"name": "<string>",
"value": "<string>",
"operator": "<string>"
}
],
"abiInputFilters": [
{
"functionName": "<string>",
"name": "<string>",
"value": "<string>",
"operator": "<string>"
}
],
"boostAddress": "<string>",
"totalParticipants": 123,
"numberMinted": 123,
"participants": [
{
"account": "<string>",
"amount": "<string>"
}
],
"boostFactoryAddress": "<string>",
"receiptsMinted": 123,
"isReceiptEnabled": true,
"actionParams": {
"type": "bridge",
"data": {
"destinationNetworkId": "<string>",
"sourceChainId": 123,
"destinationChainId": 123,
"tokenAddress": "<string>",
"tokenDecimals": 123,
"amount": "<string>",
"amountOperator": "any"
}
},
"boostAttributes": [
"<string>"
],
"isPublic": true,
"metadata": {
"image": "<string>",
"postType": "<string>",
"profileName": "<string>"
},
"fees": {
"projectFee": "<string>",
"actionFee": "<string>"
}
}