Boost Docs home page
v1
Search or ask...
boost.xyz
Support
boost.xyz
Search...
Navigation
users
total referral earnings
Documentation
API Reference
OpenAPI JSON File
auth
GET
nonce
POST
login
POST
refresh
POST
logout
GET
session
manager
GET
reward estimates
GET
mint reward estimates
GET
computed name
GET
projects
GET
registry
GET
recent completions
GET
creator summary
metrics
GET
boost protocol metrics by boost
GET
boost protocol metrics
GET
boost stats
GET
boost leaderboard
GET
user rank
GET
recent activity
GET
trending quests
GET
reward tokens
GET
supported tokens
GET
token details
accesslists
GET
accesslists by user ID
PUT
update accesslist
POST
create accesslist
DEL
archive accesslist
GET
accesslist status
GET
recommended accesslists
POST
create accesslist via boost ID
PUT
process access list
boosts
GET
participants by boost
GET
participants search
GET
download participants
POST
submit issue
POST
signature
GET
insights
GET
boost status and tx data
GET
boost details
GET
boosts
POST
create boost
users
GET
user profile
GET
user details
PUT
update profile
GET
ETH earned by user
PUT
update notification preferences
GET
farcaster profile
GET
farcaster verification status
POST
add neynar connection
DEL
remove neynar connection
POST
add twitter connection
DEL
delete twitter connection
GET
User notifications
POST
Read notifications
GET
user rewards
GET
protocol rewards summary
GET
protocol rewards earnings
GET
referrals summary
GET
referrals earnings
GET
referrals feed
GET
total referral earnings
GET
referrals activity feed
GET
active/completed boosts referrals feed
inboxes
GET
user inboxes
GET
inbox whitelist check
GET
Get a Boost Inbox
POST
Create Inbox
DEL
Delete Inbox
PATCH
Update Inbox
users
total referral earnings
Get boost referrals earnings, total referrals, and referral rank
GET
api-staging.boost.xyz
/
users
/
referrals
/
total
Send
Query
address
string
*
address
Required
string
Query Parameters
​
address
string
required
Response
200 - application/json
​
referralsEarnings
string
required
​
referralsCompleted
number
required
referrals feed
referrals activity feed
