Skip to main content
GET
/
boosts
Get a list of Boosts
curl --request GET \
  --url https://api-v2.boost.xyz/boosts
{
  "boosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "action": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "allowList": {
        "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "contractAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "type": "SimpleAllowList",
        "addresses": [
          "0x378632819f39c74c4f56b1429e760739c5fb51b7"
        ]
      },
      "boostIndex": "<string>",
      "budget": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "incentiveCount": "<string>",
      "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "validator": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "blockTimestamp": "<string>",
      "txHash": "<string>",
      "chainId": 123,
      "protocolFee": "<string>",
      "maxParticipants": "<string>",
      "incentives": [
        {
          "type": "AllowListIncentive",
          "allowListAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "limit": "<string>"
        }
      ],
      "createdAtBlockTimestamp": "<string>",
      "actionSteps": [
        {
          "chainId": 123,
          "signature": "<string>",
          "signatureName": "<string>",
          "signatureType": "event",
          "actionType": 123,
          "targetContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "parameters": {
            "filterType": 123,
            "fieldType": 123,
            "fieldIndex": 123,
            "filterData": "<string>"
          },
          "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
        }
      ],
      "createdAtChainBlockNumbers": {},
      "usdSpend": 123,
      "tokenSpend": 123,
      "isActive": true,
      "availableBudgetUsd": "<string>",
      "templateId": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "boostName": "<string>",
      "projectImageUri": "<string>",
      "tokenImageUri": "<string>"
    }
  ],
  "totalBoosts": 1
}

Query Parameters

​
page
integer | null
default:1

The desired page to return from the query

Required range: x >= 0
​
pageSize
integer | null
default:10

The amount of items to return from the query, defaults to 10, and must be <= 100

Required range: 0 <= x <= 100
​
budgetAccount
string

Filter boosts by budget account address(es). Accepts a single address or comma-separated list of addresses

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7,0x1234567890123456789012345678901234567890"

​
owner
string

Filter boosts by a specific owner address

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

​
autoboostId
string

Filter boosts by a specific autoboost ID

​
chainId
integer | null

Only retrieve Boosts for a specific chain ID. You must supply this parameter if also specifying targetContract

Required range: x >= 0
​
targetContract
string

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

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

​
tokens
string

Retrieve rewards configured with specific token addresses

Example:

"chainId:tokenAddress,chainId:tokenAddress:collection,..."

​
distributionChannel
string

Filter boosts by comma separated list of distribution channels

Example:

"distributionChannel=public,farcaster"

​
sortBy
enum<string>

Sort by active or recently deployed

Available options:
active,
recently-deployed
​
actionTemplateOnly
string

Is the Boost action template only, or has a more customized action configuration

​
showActiveOnly
string

Is the Boost active only, or has a more customized action configuration

Response

Returns a list of Boosts

​
boosts
object[]
required

An array of rewards matching provided criteria

​
totalBoosts
integer
required

The total number of rewards matching the provided criteria

Required range: x >= 0