GET
/
boosts
/
curl --request GET \
  --url https://api-staging.boost.xyz/boosts/
{
  "boosts": [
    {
      "boost": {
        "appLink": "<string>",
        "iconOption": "<string>",
        "imagePath": "<string>",
        "name": "<string>",
        "boostEnd": "<string>",
        "boostStart": "<string>",
        "completions24h": 123,
        "completions7d": 123,
        "completions30d": 123,
        "completionsAll": 123,
        "description": "<string>",
        "network": "<string>",
        "receiptsMinted": 123,
        "status": "<string>",
        "createdAt": "<string>",
        "contractAddress": "<string>",
        "creatorAddress": "<string>",
        "task": {
          "name": "<string>",
          "description": "<string>",
          "link": "<string>",
          "iconOption": "<string>",
          "deprecated": true,
          "timestamp": "<string>",
          "contractAddress": "<string>",
          "eventName": "<string>",
          "status": "<string>",
          "webhookUrl": "<string>",
          "indexerStrategy": "<string>",
          "title": "<string>",
          "network": {
            "name": "<string>",
            "chainId": "<string>"
          }
        },
        "tasks": [
          {
            "name": "<string>",
            "description": "<string>",
            "link": "<string>",
            "iconOption": "<string>",
            "deprecated": true,
            "timestamp": "<string>",
            "contractAddress": "<string>",
            "eventName": "<string>",
            "status": "<string>",
            "webhookUrl": "<string>",
            "indexerStrategy": "<string>",
            "title": "<string>",
            "network": {
              "name": "<string>",
              "chainId": "<string>"
            }
          }
        ],
        "isReceiptEnabled": true,
        "tags": [
          "<string>"
        ],
        "actionParams": {
          "type": "bridge",
          "data": {
            "destinationNetworkId": "<string>",
            "sourceChainId": 123,
            "destinationChainId": 123,
            "tokenAddress": "<string>",
            "tokenDecimals": 123,
            "amount": "<string>",
            "amountOperator": "any"
          }
        },
        "metadata": {
          "image": "<string>",
          "postType": "<string>",
          "profileName": "<string>"
        }
      },
      "reward": {
        "amount": "<string>",
        "totalAllocated": 123,
        "type": "<string>",
        "tokenSymbol": "<string>",
        "token": "<string>",
        "network": "<string>",
        "s3Link": "<string>",
        "ethValue": "<string>",
        "tokenContractAddress": "<string>"
      }
    }
  ]
}

Query Parameters

​
pageNo
number

page number (1-indexed); defaults to 1

​
pageSize
number

page size; defaults to 10

​
status
string

only valid if address is also included

​
ethValue
string
​
searchQuery
string

search across creator address (including ENS), boost address, reward token, boost id, and project name and id, FID, and action metadata

​
tags
string
​
exclusionTags
string
​
actionFilters
string

ignored unless address is also included

​
excludeActionFilters
string
​
actionChainIds
string

If included, only boosts for actions on the specified chains will be returned.

Example:

"10,8453,42161"

​
projectIds
string
​
creatorAddresses
string

If included, only boosts created by one of the specified addresses will be returned.

Example:

"0x...123,0x...456,0x...789"

​
rewardTokenNetworks
string
deprecated

DEPRECATED -- use rewardTokenChainIds instead

Example:

"opt-mainnet,zora-mainnet"

​
rewardTokenChainIds
string

If included, only boosts with rewards on the specified chains will be returned.

Example:

"10,8453,42161"

​
rewardTokenAddresses
string

If included, only boosts with rewards in the specified tokens will be returned. Note: must be used with and match up one-to-one with rewardTokenNetworks.

Example:

"0x...123,0x...456,0x...789"

​
tokens
string

If included, only boosts matching the specified token parameters will be returned. Format: chainId:contractAddress or chainId:contractAddress:tokenId

Example:

"10:0x...123,8453:0x...456:1"

​
sortBy
enum<string>
Available options:
profitability,
time-remaining,
deploy-date,
completions-24h,
completions-7d,
completions-30d,
completions-all
​
preferFeatured
string

If set to true, boosts with the "featured" tag will be returned first

Example:

"true"

​
address
string
required

If included, only boosts with the user on their accesslists will be returned. If not included, public boosts will be returned.

​
completerAddress
string
required

If included, only boosts completed by this user address will be included. Overrides address and status.

​
isPublic

If pass as true, show only public boosts (defaults to true if no address is provided)

Available options:
true

Response

200
application/json

Success

The response is of type object.