Your app.
Our creator economy.
Discover creator and club markets. Bring key trading, staking and Cheers tipping to your own Mini App.
Public access needs no API key. Availability depends on release activation. Market and tipping requests share 30 requests per minute per IP. Cache reads, respect Retry-After, and back off on 429/503. Fresh work also has a global capacity limit.
Start with the market
Base Mainnet, chain ID 8453. Base URL:
https://basefriend.tech/api/public/basefriend/v1.
| GET resource | What it gives you |
|---|---|
/config |
Contract, ABI, current payment asset and settlement identity. |
/markets?q=alice&type=creator&limit=20 |
Searchable creator or club profiles, pictures, supply and indicative prices. Clubs use type=channel. |
/market?id=ENTITY_UUID |
One registered market. |
/wallet?wallet=0x… |
Free and staked keys, indexed unlocks and indexed claimable rewards. Follow nextCursor for all pages. |
/quote?entityId=UUID&wallet=0x…&side=buy&amount=1
|
Short-lived wallet-specific price, fee, Genesis debt and settlement identity. |
const base = "https://basefriend.tech/api/public/basefriend/v1";
const response = await fetch(`${base}/markets?limit=20`, {
credentials: "omit"
});
if (!response.ok) throw new Error(`API returned ${response.status}`);
const { data, asOf, expiresAt } = await response.json();
// data.items, data.nextCursor, data.settlement, data.source
Amounts and token IDs are exact strings. Keys are whole units (0 decimals); payment amounts are atoms (18 decimals). Indexed data can lag and is cached up to 60 seconds. Indicative list prices are not trade quotes.
Let users buy, sell and stake
POST /prepare returns an unsigned call
for buy, sell, stake, unstake, claim_rewards or claim_creator_fees.
The user signs in their own wallet; BaseFriend does not custody funds
or submit the transaction.
// 1. Connect a wallet; get a fresh wallet-specific quote.
const quote = await fetch(`${base}/quote?` + new URLSearchParams({
entityId, wallet: account.address, side: "buy", amount: "1"
}), { credentials: "omit" }).then(async r => {
if (!r.ok) throw new Error(`Quote failed: ${r.status}`);
return (await r.json()).data;
});
// 2. Prepare against the exact payment asset and reviewed reference.
const response = await fetch(`${base}/prepare`, {
method: "POST", credentials: "omit",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ action: "buy", wallet: account.address,
entityId, amount: "1", referenceAmount: quote.reserveAmount,
slippageBps: 100, maxGenesisDebtPayment: "0",
settlementIdentity: quote.settlementIdentity })
});
if (!response.ok) throw new Error(`Prepare failed: ${response.status}`);
const prepared = (await response.json()).data;
// Verify/decode the call and any exact-amount approval first.
// Simulate, obtain user consent, then sign through the user's wallet.
-
Verify chain, contract, caller, receiver, method, amount, fee,
slippage and current settlement asset independently. Contract:
0x2df05c3238f5d1edf8c03ff78698ff41b84f3997. - Review Genesis debt fields before a sale; extra debt payment defaults to zero.
- If an approval is returned, simulate and have the user confirm its exact amount. Wait for its receipt, then refresh quote and preparation. Quotes expire within 10 seconds.
- Simulate the main call from the same wallet, then have the wallet sign and send. Preserve its hash; use your RPC or wallet to wait for a successful receipt. Check pending hashes before retrying.
-
Stake request:
{action:"stake",wallet,entityId,amount:"1"}. Unstake uses the same fields. Fresh preparation checks live unlocked quantity. Contract locks still apply. -
Reward claim:
{action:"claim_rewards",wallet,entityIds:[UUID],settlementIdentity}. Creator-fee claim usesclaim_creator_feesand oneentityId. Genesis verification uses BaseFriend's existing claim flow.
View the market OpenAPI specification for exact request and response schemas.
Build with Cheers
Existing public data API: /api/public/tipping/v1. Read
/summary, /account?fid=12345, or
/leaderboard?direction=received&period=all&limit=20.
CHEERS prelaunch accrual is not a funded claimable token balance. Do not describe pending rewards or forecasts as spendable funds. Public tipping routes display data; they do not authorize tips or claims. Tipping OpenAPI specification.
Apply for a builder grant
Monthly builder rewards · 1,250,000 CHEERS
- 1st place: 500,000 CHEERS
- 2nd place: 300,000 CHEERS
- 3rd place: 100,000 CHEERS
- 4th–10th place: 50,000 CHEERS each
Open GRANT in BaseFriend, connect and sign in with your wallet, then share your live app, integration, activity report and evidence links. Chef reviews usefulness, quality and genuine activity and assigns an independent grant score.
Successful attributed requests and verified actions earn provisional activity points. Chef assigns the final grant score after review. Grant scores are separate from App Points, CHEERS and $KEY; a score does not guarantee a payout. Applications and feedback are visible to the submitting wallet and Chef. Updating an application starts a new review and resets its current score.
Track your app’s API activity
In your application, open API ACCESS & ACTIVITY. Create a server API key and save it privately on your backend. The full key is shown once. Use this same key for market and tipping requests; anonymous access remains available with the same limits.
curl -sS -i \
-H "Authorization: Bearer ${BASEFRIEND_APP_API_KEY}" \
'https://basefriend.tech/api/public/tipping/v1/summary'
X-BaseFriend-Usage: recorded confirms tracked usage.
Never put a secret key in a Mini App bundle, public URL or repository.
Browser apps should use anonymous calls or their own backend proxy.
Invalid or revoked keys return 401; keyed responses are private and
uncached. You can rotate or revoke a key from the same panel.
You and Chef can see private daily and endpoint reports for the last 7, 30 or 90 UTC days. Counts show use of your key, not verified people or completed trades. The activity panel also shows provisional points, verified actions and daily caps. Chef reviews the app and its activity before assigning its final grant score.
Activity points
Each UTC day: up to 100 points from reads and preparation, and 500 points overall. Requests require a valid app key, a successful GET/POST response and recorded usage. Anonymous requests, errors, HEAD, OPTIONS and 304 responses earn zero points.
| Creator / club action | Prepare | Finalized transaction |
|---|---|---|
| Buy keys | 2 | 25 |
| Sell keys | 0 | 3 |
| Stake keys | 2 | 20 |
| Unstake keys | 0 | 2 |
| Claim staking rewards | 0 | 5 |
| Claim creator / club fees | 0 | 8 |
| Claim creator / club Genesis | 0 | 100 |
Read points: configuration 0; browse creators, clubs or search 1; market details 2; wallet holdings and staking 3; buy quote 2; sell quote 1; tipping summary 1; tipping account 3; sender or receiver leaderboard 1.
With your app key, /prepare returns an app-bound activity
intent. Send the exact reviewed calldata, preserve the submitted hash,
then call POST /api/public/basefriend/v1/confirm with
{intentId, txHash}. A 202 response means wait at least 60
seconds and retry confirmation; do not resend the transaction. Only
matching finalized direct market transactions qualify. Wrapped
Safe/multicall/account-abstraction calls are not supported for
transaction attribution in this version.
A transaction scores once. Buys and stakes score once per wallet and market per UTC chain day, across all apps. Genesis scores once per market; existing claimant approvals and authorization rules still apply. Reward and fee claims must be positive; a batch reward claim earns 5 total. Earlier unclassified traffic earns no retroactive points. Activity points do not change final grant scores or token balances.
OPEN BASEFRIEND →