# Rabbithole

> Documentation for Rabbithole: earning on rabbithole.gg, running campaigns, and integrating campaign data and claims into your own product.

- [What Is Rabbithole](https://docs.rabbithole.gg/rabbithole/introduction.md): Get paid to watch your money grow: deposit into supported protocols, hold, and earn rewards every second
- [Getting Started](https://docs.rabbithole.gg/rabbithole/getting-started.md): Sign in, link a wallet, get verified, and make your first deposit on rabbithole.gg
- [Hold to Earn](https://docs.rabbithole.gg/rabbithole/hold-to-earn.md): Browse campaigns, read the campaign panel, deposit, watch rewards accrue, and claim
- [Tiers and Leaderboard](https://docs.rabbithole.gg/rabbithole/tiers-and-leaderboard.md): How the weekly leaderboard ranks you, what each tier unlocks, and how to climb
- [Raffle](https://docs.rabbithole.gg/rabbithole/raffle.md): How the monthly raffle works: earning entries from your tier, bonus entries, the draw, and claiming a prize
- [Referrals](https://docs.rabbithole.gg/rabbithole/referrals.md): Share a campaign with your invite link and earn a share of what the people you refer earn
- [FAQ](https://docs.rabbithole.gg/rabbithole/faq.md): Answers to the questions people ask first about earning on Rabbithole
- [Campaigns](https://docs.rabbithole.gg/campaigns/introduction.md): Reward users for keeping eligible onchain positions active over time
- [Why Rabbithole](https://docs.rabbithole.gg/campaigns/why-rabbithole.md): Curated incentive campaigns with per-deposit attribution: see how much TVL was routed, where it came from, and what your budget bought
- [How It Works](https://docs.rabbithole.gg/campaigns/how-it-works.md): How a campaign actually runs — from goal to earning to claim
- [Reward Calculation](https://docs.rabbithole.gg/campaigns/reward-calculation.md): How eligible balance and time held translate into rewards
- [Campaign Lifecycle](https://docs.rabbithole.gg/campaigns/campaign-lifecycle.md): The phases a campaign moves through, from setup to claim window close
- [Campaign Modes](https://docs.rabbithole.gg/campaigns/campaign-modes.md): Stackable rules that shape who earns and how much during a campaign
- [Earning Activation](https://docs.rabbithole.gg/campaigns/earning-activation.md): Limit campaign rewards to users who entered the position through Boost
- [Launch a Campaign](https://docs.rabbithole.gg/campaigns/launch-a-campaign.md): How to bring a campaign to life with the Rabbithole team
- [Methodology](https://docs.rabbithole.gg/campaigns/methodology.md): How a Rabbithole campaign is measured, what qualifies, and what is published
- [Pricing](https://docs.rabbithole.gg/campaigns/pricing.md): How campaigns are charged, what users pay, and what happens to budget nobody claims
- [Referrals](https://docs.rabbithole.gg/campaigns/referrals.md): Pay the people and partners who bring depositors, out of the campaign fee rather than the reward budget
- [Glossary](https://docs.rabbithole.gg/campaigns/glossary.md): Quick reference for terms used across these docs
- [Developer Overview](https://docs.rabbithole.gg/developers/overview.md): Integrate a live campaign into your own product: campaign data, user rewards, and on-chain claiming
- [Quickstart](https://docs.rabbithole.gg/developers/quickstart.md): Discover a campaign, show a user what they've earned, and submit a claim, in five steps
- [Campaigns, IDs, and Chains](https://docs.rabbithole.gg/developers/concepts/campaigns.md): The compound campaign key, event versus reward chains, lifecycle status, and what discovery returns
- [How Claiming Works](https://docs.rabbithole.gg/developers/concepts/claiming.md): Merkle roots, cumulative amounts, and what claimable actually means
- [Data Conventions](https://docs.rabbithole.gg/developers/concepts/data-conventions.md): Wire formats, bigint amounts, pagination, caching, and how the /v1 contract evolves
- [Display Campaign Stats](https://docs.rabbithole.gg/developers/guides/display-campaign-stats.md): Show a live Boost APR, TVL, and participant count next to your pool or vault
- [Show User Rewards](https://docs.rabbithole.gg/developers/guides/show-user-rewards.md): Earned versus claimable, the UI states in between, and how to format the amounts
- [Claim Rewards](https://docs.rabbithole.gg/developers/guides/claim-rewards.md): Submit the claim from your own UI, with viem or from any stack using raw calldata
- [Forwarder Deposits](https://docs.rabbithole.gg/developers/guides/forwarder-deposits.md): Route deposits through the Boost Forwarder for campaigns that require it
- [TypeScript SDK](https://docs.rabbithole.gg/developers/sdk.md): Install @boostxyz/tbi-sdk, configure a client, and use the full method surface
- [Contracts](https://docs.rabbithole.gg/developers/contracts.md): The TBI Manager, the claim function, and every revert selector
- [Errors](https://docs.rabbithole.gg/developers/errors.md): The API error envelope, the SDK error classes, and how to handle each one
- [API Overview](https://docs.rabbithole.gg/api-reference/introduction.md): The public REST API behind Rabbithole campaigns: base URL, authentication, and conventions
- [List campaigns](https://docs.rabbithole.gg/api-reference/campaigns/list-campaigns.md): Lists SDK-facing campaigns with optional chain, status, target, user, budget, and claimability filters.
- [List active campaigns](https://docs.rabbithole.gg/api-reference/campaigns/list-active-campaigns.md): Convenience endpoint for active campaign discovery. The status query parameter is intentionally unsupported.
- [Get a campaign](https://docs.rabbithole.gg/api-reference/campaigns/get-a-campaign.md)
- [Get campaign stats](https://docs.rabbithole.gg/api-reference/campaigns/get-campaign-stats.md): Stats-only campaign payload for polling without refetching campaign metadata.
- [Get a claim proof](https://docs.rabbithole.gg/api-reference/claims/get-a-claim-proof.md): Returns the latest claim proof and precomputed claimable amount for one campaign and address.
- [List claim statuses](https://docs.rabbithole.gg/api-reference/claims/list-claim-statuses.md): Returns bounded claim status rows for one user across repeated or comma-separated campaignIds.
- [List supported Forwarder deposit targets](https://docs.rabbithole.gg/api-reference/forwarder/list-supported-forwarder-deposit-targets.md): Returns registered targets that can be deposited through the Boost Forwarder from the public SDK surface.
- [Build a Forwarder deposit transaction list](https://docs.rabbithole.gg/api-reference/forwarder/build-a-forwarder-deposit-transaction-list.md): Builds a direct same-chain Boost Forwarder deposit transaction list for a supported target. The server infers the accepted input token from the target registry.
- [Bind a referee to a referrer for one campaign](https://docs.rabbithole.gg/api-reference/referrals/bind-a-referee-to-a-referrer-for-one-campaign.md): Accepts the referee's signed per-campaign referral bind. The referral code IS the referrer's wallet address; the server canonicalizes smart-wallet proxies (Polymarket/Forkast Safe) to their owner EOA before storing. The referee signs EIP-712 typed data: domain {name: 'Boost TBI Referrals', version:…
- [Get a referral claim proof](https://docs.rabbithole.gg/api-reference/referrals/get-a-referral-claim-proof.md): Returns the latest published referral merkle proof for a referrer, for the TBI Manager's claimReferral(campaignId, referrer, amount, proof) function, which pays out of the campaign's on-chain ReferralDistributor (distributorAddress — manager-only; read its claimed(referrer) view for claim status). R…
- [Get referrer earnings per campaign](https://docs.rabbithole.gg/api-reference/referrals/get-referrer-earnings-per-campaign.md): Per-campaign referral earnings for a referrer. Rows are status 'estimated' while a campaign is live (referees' current accrued rewards with the referral rate applied, then scaled pro-rata into the referral pool against every referrer's share — amount is the projected payout) and 'final' once the pos…
- [List user rewards](https://docs.rabbithole.gg/api-reference/users/list-user-rewards.md): Lists campaigns where the user has triggered and accrued rewards.
- [List user token balances](https://docs.rabbithole.gg/api-reference/users/list-user-token-balances.md): Returns wallet token balances from the configured Zerion upstream, normalized for SDK consumers.

## OpenAPI Specs

- [openapi](https://api-tbi.boost.xyz/v1/openapi.json)

## Optional

- [Open Rabbithole](https://app.rabbithole.gg)
- [Discord](https://discord.gg/JTCqaekdm)