Boost Docs

Documentation

API Reference

SDK Docs

Boost API

boost.xyz

Support

Retrieve a list of Boosts, optionally filtering by owner, budget, chain ID, and more.

Get Boosts

Defines a specific step required to complete the boost

Type identifier for the action being performed

ID of the blockchain network where this step occurs

Address of the user performing the action

Configuration parameters for the action step

Function or event signature to verify the action

Whether the signature is for an event or function call

Address of the contract where the action occurs

Configuration for controlling participation eligibility

List of addresses that are either allowed or denied

Address of the allow list owner/administrator

Type of list - either allowing specific addresses or denying specific addresses

Incentive that grants access to an allow list

Maximum number of addresses that can be added to the allow list

Identifies this as an allow list incentive type

Represents a complete boost campaign configuration

Contract address where the boost action is implemented

Array of steps required to complete the boost

Configuration for controlling who can participate in the boost

Timestamp of the block when the boost was created

Sequential index of the boost within the contract

Address of the contract handling boost rewards

ID of the blockchain network where the boost is deployed

Map of chain IDs to block numbers when the boost was created

Number of incentives configured for this boost

Array of rewards offered for completing the boost

Maximum number of users who can participate in the boost

Fee charged by the protocol for the boost

The Boost's chain id and stringified bigint index separated by a colon

Continuous Gradual Dutch Auction incentive mechanism

Rate at which the reward decreases over time

Total amount of tokens allocated for rewards

Maximum number of rewards that can be distributed

Total number of claims made for this incentive

Identifies this as a standard ERC20 incentive type

Variable amount ERC20 token reward with additional criteria

Maximum number of criteria-based rewards that can be distributed

Base amount of tokens to be rewarded, varies based on specific criteria

Total amount of tokens claimed from this incentive

Identifies this as a variable criteria ERC20 incentive type

Variable amount ERC20 token reward incentive

Maximum number of variable rewards that can be distributed

Base amount of tokens to be rewarded, may vary based on conditions

Identifies this as a variable ERC20 incentive type

Union type of all possible incentive types

Configuration parameters for action verification

Type of filter to apply to the action data

Response containing list of boosts and total count

Introduction to Boost V2

Understanding the vision and rationale behind Boost

Why We Built Boost

Redefining Network Participation and Ownership

The Vision of Boost

Explore the new features and improvements in Boost V2

What's New in V2

Guide on how budget accounts work in Boost V2

Budget Accounts

Step-by-step guide on how to deploy new Boost incentive programs

Deploying Boosts

Understanding the basics of selecting actions for your Boost

Introduction to Action Selection

Learn how to interpret transaction data on Etherscan for Boost actions

Understanding Etherscan Data

How to use Etherscan data to configure your Boost actions

Setting Up Boost Actions

Advanced strategies for creating more complex and targeted Boost actions

Advanced Action Selection Techniques

Overview of the tokens supported for rewards in Boost V2

Tokens Supported

Effective approaches to distribute rewards in Boost V2

Strategies for Reward Distribution

Managing and optimizing your reward budget in Boost V2

Guide on how users can interact with Boosts and claim earned rewards

Claiming Rewards

An overview of the Boost V2 core protocol architecture and its components

Boost V2 Core Protocol Architecture

A comprehensive comparison of Boost V2 and Boost V1 features and architecture

Boost V2 vs. Boost V1

Overview of deployed contract addresses across all supported networks

Deployed Contracts

Boost SDK

Boost API Reference

Joining the Boost Community

Answers to frequently asked questions about Boost

Frequently Asked Questions

Introduction

What is a Boost?

How It Works

An overview of the Boost Protocol and ecosystem

Boost Protocol

Boost Manager

Boost Clients

Attribution System

Protocol Fees & Rewards

Affiliate Referrals

Boost Guild Treasury

How to Add Your Project to the Boost Registry

How to Deploy a Boost

How to Add a Token to the Whitelist

Learn how to integrate Boost Protocol into your Rollup

Integration Guide for Rollups

How to sign in to Boost using Sign-In with Ethereum

Sign in to Boost

How to create a boost using the Boost API

Create a Boost

How to query all Boosts with various filters

Fetch Boosts

Claim a Boost

Download the OpenAPI JSON specification for the Boost API

OpenAPI JSON File

nonce

login

refresh

logout

session

reward estimates

Get reward estimates for a mint action. Returns response in ETH value

mint reward estimates

computed name

Returns all approved projects and their respective tasks

projects

registry

Get a list of recent boost completions by creator address

recent completions

Get total boost completions driven, total boost spend, and ranking by creator address

creator summary

Get hourly or daily Boost protocol metrics for a given date range for a boost

boost protocol metrics by boost

Get hourly or daily boost protocol metrics for a given date range

boost protocol metrics

boost stats

Returns the top 50 users in the leaderboard over the given period and with project, action, and network filters applied

boost leaderboard

returns the user rank for the given rank mode

user rank

recent activity

trending quests

reward tokens

supported tokens

token details

Sort and filter with a query of accesslists for a given user id.

accesslists by user ID

update accesslist

create accesslist

archive accesslist

accesslist status

Get a list of public recommended accesslists

recommended accesslists

create accesslist via boost ID

process access list

Get all participants for a boost. Returns paginated results.

participants by boost

Search participants in a boost by address query string. Returns paginated results.

participants search

Download participants table for a boost in CSV format

download participants

submit issue

Get the ECDSA signature used for claiming rewards

signature

insights

get the boost status and tx data for a given user address and boostId (tx data only available if boost is "redeemable" or "completed" status

boost status and tx data

Get boost details for a specific boostId, optionally including an address to retrieve user-specific boost details

boost details

Returns all boosts, optionally filtered by whether the user exists on their respective accesslists

boosts

Query Parameters

Response