Skip to main content
Rabbithole campaigns expose a public REST API and a TypeScript SDK for building campaign experiences inside your own product. Show a live reward APR next to your pool, surface what a user has earned, and let them claim without ever leaving your app. This is a read and claim surface. It never takes custody of funds and never mutates Boost state server-side. Claims and deposits are transactions your users sign.
Campaigns are not self-serve today. The Boost team scopes, integrates, and deploys each one (see Launch a Campaign). These pages are for integrating a campaign that already exists.
Campaign already live? Go straight to the Quickstart.

​
Get Access

There is less to arrange than you might expect.
  1. A live campaign. Rewards have to be running against a vault, pool, or token before there is anything to display. Start that conversation with the team on Discord.
  2. A partner refId. An attribution ID that Boost assigns manually. The SDK sends it as the x-boost-ref-id header on every request so campaign usage can be credited to your integration. It is not authentication and not a secret.
  3. Nothing else. There is no API key, no signup, and no signed request. Every endpoint in these docs is public.
Ask for a refId in your shared partner channel with the Boost team, or on Discord, before you ship. Everything works without one; you just lose the attribution.

​
What You Can Build

Display Campaign Stats

Show a live reward APR, TVL, and participant count next to your own pool numbers. One request, no wallet.

Show User Rewards

Render what a user has earned and what they can claim, with every state in between.

Claim Rewards

Put a working claim button in your own UI: batched, simulated, and relayer-friendly.

Forwarder Deposits

Route deposits through the Boost Forwarder for campaigns that require activation.

​
SDK or Raw REST

Both are first-class and hit the same endpoints. The SDK converts decimal strings to bigint, parses timestamps, and ships claim helpers that build and submit the transaction. Raw REST works from any language, but you own the parsing and the calldata encoding.
The base URL is https://api-tbi.boost.xyz, and the only server-side environments are production and local development. There is no partner-facing staging host.

​
Shared Fundamentals

These apply across every guide:
  • Campaigns, IDs, and Chains: the compound campaign key, the event-versus-reward-chain rule, lifecycle status, and campaign modes as data.
  • How Claiming Works: merkle roots, cumulative amounts, and why earned and claimable are different numbers.
  • Data Conventions: wire formats, bigint amounts, pagination, caching, and rate limits.
  • TypeScript SDK: install, configuration, and the full method surface.
  • Errors: the shared error envelope and the typed SDK classes.
  • Contracts: the TBI Manager, the claim signature, and every revert selector.
  • API Reference: every endpoint, parameter, and response schema, generated from the live OpenAPI spec.

​
Keep Exploring

Quickstart

Discover, read, and claim in five steps.

How It Works

The campaign model behind the API, from goal to earning to claim.