BOboost
RewardKit

Get a list of reward kit rewards

Changed on

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

get/reward-kit/boosts

Request

  • Base URL
    https://api-v2.boost.xyz
  • Auth
    none declared

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

creatorAddressstring

Filter rewards by the reward creator's address.

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7
claimantAddressstring

Filter rewards by the address of the claimant.

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7
status'active' | 'claimed' | 'claimable'

Filter rewards by their status, either active, claimed, or claimable.

actionTypestring

Filter by the type of actions that must be taken to claim the reward, eg: "mint", "swap"

Example:swap,mint
excludeActionTypestring

Exclude rewards with these action types, eg: "mint", "swap"

Example:mint,create-any-token
includeTokenMetadataboolean nullable

Include token metadata (price, market cap, etc.) for applicable actions. Defaults to false.

Example:true

Response

Returns a list of RewardKit rewards

Example response

{
  "boosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "metadata": {
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
          }
        }
      ],
      "actionTemplate": {
        "actionType": "mint",
        "category": "defi"
      },
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ]
}

Changes

  • 3f98a3931058Revision changes
    • info

      added the new optional query request parameter actionType

    • info

      added the new optional query request parameter autoboostId

    • info

      added the new optional query request parameter distributionChannel

    • info

      added the new optional query request parameter excludeActionType

    • info

      added the new optional query request parameter includeTokenMetadata

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter tokenWhitelist

    • info

      removed the pattern ^0x[a-fA-F0-9]{40}$ from the query request parameter budgetAccount

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 2b7b8b35aa45Revision changes
    • info

      endpoint added