Boost Docs

Documentation

API Reference

SDK Docs

boost.xyz

Support

Boost API Reference

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 various scenarios where Boost V2 can be applied with specific examples

Boost V2: Specific Use Cases and Examples

How Zora leveraged Boost V2 to accelerate creator onboarding

Case Study #1: Zora

How Coop Records used Boost V2 to amplify music NFT releases

Case Study #2: Coop Records

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

Boost SDK

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

create boost

Get eth earned, ranking and score for a user

user profile

This endpoint returns information about the logged in user address.

user details

update profile

This endpoint gets the eth earned for a user

ETH earned by user

This endpoint updates a user's notification preferences.

update notification preferences

Get the farcaster profile for a given user address

farcaster profile

Get the farcaster verification status for a given user

farcaster verification status

add neynar connection

Remove neynar connection from a user profile

remove neynar connection

add twitter connection

Remove twitter details for a user profile

delete twitter connection

user rewards

protocol rewards summary

protocol rewards earnings

referrals summary

Get the earnings from referrals for a user

referrals earnings

Get boost referrals feed and profile data for a user

referrals feed

Get boost referrals earnings, total referrals, and referral rank

total referral earnings

referrals activity feed

Get referrals activity feed aggregated by boosts

active/completed boosts referrals feed

This endpoint will retrieve the given user's inboxes.

user inboxes

This endpoint will check if the user is in the whitelist.

inbox whitelist check

This endpoint will retrieve a single Boost Inbox if it exists.

Get a Boost Inbox

This creates a new Inbox for the authenticated user

Create Inbox

Delete Inbox

Update Inbox

Interacting directly with Boosts in Node and the Browser

Overview

Installation

Quick Start

Usage With React

Learn how to get logs and listen for new events emitted by the protocol

Working with Events

How to add your contracts' function and event signatures into Boost's well-known registry

Integrating your Protocol or DApp

Learn how to reward users with ERC20 rewards when they mint an NFT on Zora.

Boost an NFT Mint on Zora

Learn how to reward users with ERC20 rewards when they vote for/against a specific proposal

Boost a Vote on Agora

Claim Rewards from a Boost

Learn about the role the Registry plays in the SDK

Initializing Components

Cloned Components

Learn about how to use the Boost Core contract with the SDK

Get Boosts

Claiming Incentives

Learn about how to interact with the Managed Budget using the SDK

Authorization

Funding

Retrieval

Download the OpenAPI JSON specification for the Boost V2 API

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

Retrieve detailed information about a specific Boost by ID

Get Boost details

Get Boost activity

Given a transaction hash, validate that a user has successfully completed the Boost's configured action, and return a signed payload for use with `BoostCore.claimIncentive` or `BoostCore.claimIncentiveFor`. Any Boost created with our default validator can use this endpoint with the claim flow.

Overview

How it works

For Developers

Support

Boost API Reference