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

boostId
string
required

Query Parameters

address
string
required

Response

200
application/json
Success
id
string
required
contractAddress
string
required
iconOption
string
required
imagePath
string
required
instructionsUrl
string | null
required
name
string
required
network
string
required
queued
boolean
required
completions24h
number | null
required
completions7d
number | null
required
completions30d
number | null
required
completionsAll
number | null
required
description
string
required
status
string
required
reward
object | null
required
task
object | null
required
boostAddress
string
required
totalParticipants
number
required
numberMinted
number
required
isReceiptEnabled
boolean
required
disabled
boolean
boostEnd
string
boostStart
string
eligibility
object
tasks
array
deprecated

DEPRECATED -- use "task" instead; "tasks" is always an array of length 1

creatorAddress
string | null
filters
object[] | null
abiInputFilters
object[] | null
participants
object[]
boostFactoryAddress
string
receiptsMinted
number
actionParams
object
boostAttributes
string[]
isPublic
boolean
metadata
fees
object | null