v2

latestOpenAPI 3.1.02026-08-01170225.5 KB

Boost

Get a list of Boosts

Accepts pagination, and filter options to return a list of boosts

get/boosts

Query parameters

pageinteger nullable

The desired page to return from the query

pageSizeinteger nullable

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

budgetAccountstring

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

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7,0x1234567890123456789012345678901234567890

ownerstring

Filter boosts by a specific owner address

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7

autoboostIdstring

Filter boosts by a specific autoboost ID

chainIdinteger nullable

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

targetContractstring

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

tokensstring

Retrieve rewards configured with specific token addresses

Example:chainId:tokenAddress,chainId:tokenAddress:collection,...

distributionChannelstring

Filter boosts by comma separated list of distribution channels

Example:distributionChannel=public,farcaster

sortBy'active' | 'recently-deployed'

Sort by active or recently deployed

tokenWhitelistboolean nullable

Filter boosts by token whitelist

actionTemplateOnlystring

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

showActiveOnlystring

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

Response

Returns a list of Boosts

totalBoostsinteger required

The total number of rewards matching the provided criteria

Example response

{
  "boosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "action": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "allowList": {
        "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "contractAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "addresses": [
          "0x378632819f39c74c4f56b1429e760739c5fb51b7"
        ]
      },
      "budget": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "validator": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
      "actionSteps": [
        {
          "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "targetContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
        }
      ],
      "incentives": [
        {
          "allowListAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
        }
      ]
    }
  ]
}