BOboost
Boost

Get a list of Boosts

Changed on

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

get/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

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"
        }
      ]
    }
  ]
}

Changes

  • 3f98a3931058Revision changes
    • breaking

      added subschema #6 subschema #7 subschema #9 subschema #10 to the /// response property oneOf list for the response status

    • warning

      added the new OffchainAccessList enum value to the /// response property for the response status

    • 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 showActiveOnly

    • 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

      removed subschema #6 subschema #7 subschema #9 subschema #10 from the /// response property oneOf list for the response status

  • 2b7b8b35aa45Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property //// became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 to the /// response property oneOf list for the response status

    • breaking

      the //// response's property type changed from integer to number for status

    • breaking

      the ///// response's property type changed from integer to number for status

    • breaking

      the ///// response's property type changed from integer to number for status

    • breaking

      the ///// response's property type changed from integer to number for status

    • warning

      for the query request parameter pageSize, the max was set to 100.00

    • warning

      for the query request parameter chainId, the min was set to 0.00

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new OpenAllowList enum value to the /// response property for the response status

    • info

      api operation id getBoosts was added

    • info

      api tag Boost added

    • info

      api tag boosts removed

    • info

      added the new optional query request parameter actionTemplateOnly

    • info

      added the new optional query request parameter targetContract

    • info

      added the new optional query request parameter tokens

    • info

      the query request parameter page became optional

    • info

      the query request parameter pageSize became optional

    • info

      for the query request parameter page, the min was decreased from 1.00 to 0.00

    • info

      for the query request parameter pageSize, the min was decreased from 1.00 to 0.00

    • info

      added the non-success 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

      removed from the /// response property anyOf list for the response status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the // response's property pattern ^[0-9]+:[0-9]+$ was removed for the status

    • info

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