查看英文原文
Updated status: confirmed
Reward type: points
Getting Started ⚡ What is Fuul? 💪 Why Use Fuul? 🚀 Quickstart 🤔 Use Cases ⚙️ How Integration Works 💰 How to Add a Budget in Fuul
⚡ What is Fuul?
💪 Why Use Fuul?
🚀 Quickstart
🤔 Use Cases
⚙️ How Integration Works
💰 How to Add a Budget in Fuul
Core Concepts 💸 Types of Rewards ✅ Trigger Integrations 🤑 Incentive Payouts 🏆 Tiers & Multipliers 🏁 Trading Competitions 🧑🤝🧑 Referrals 🤝 Affiliates 🏦 Budgets & Smart Contracts 🛡️ Fraud Prevention
💸 Types of Rewards
✅ Trigger Integrations
🤑 Incentive Payouts
🏆 Tiers & Multipliers
🏁 Trading Competitions
🧑🤝🧑 Referrals
🤝 Affiliates
🏦 Budgets & Smart Contracts
🛡️ Fraud Prevention
Fuul MCP Server 🚀 Quickstart 💸 Managing Incentives ⚡ Managing Triggers 🤝 Managing Referrals 👥 Managing Affiliates 💵 Payout Approvals 📡 Sending Events
💸 Managing Incentives
⚡ Managing Triggers
🤝 Managing Referrals
👥 Managing Affiliates
💵 Payout Approvals
📡 Sending Events
Incentives Manager ⚡ Fuul Incentives Manager 🏅 Badges 🏁 Creating Triggers 💻 Incentives Hub
⚡ Fuul Incentives Manager
🏅 Badges
🏁 Creating Triggers
💻 Incentives Hub
Developer Guide ⭐ SDK Setup & Installation 👨💻 API Key Management 🛠️ Build Your Incentives Hub 🎛️ Tracking Referrals ⚙️ Sending Custom Events 🔔 Webhooks 🔗 Affiliate Links & Codes 📊 Affiliate Dashboard 🤝 Referral Codes 💯 Leaderboard Data ⛓️ Tokens 🌟 Points 🔈 Volume 🙋 Individual Rewards 📊 Referred Metrics 📱 Verifying X Follows 📊 Whitelabel TVL & APR 🪙 Claim Flow Integration 🎁 Public Claimable Rewards 🤙 Claiming Onchain Rewards 🪂 Airdrop Distributor 📢 Managing Audiences 📜 Terms & Conditions 🆘 Troubleshooting ⚠️ Error Handling ✈️ SDK Migration (5.x → 7.x) 🗂️ API Endpoint Directory
⭐ SDK Setup & Installation
👨💻 API Key Management
🛠️ Build Your Incentives Hub
🎛️ Tracking Referrals
⚙️ Sending Custom Events
🔔 Webhooks
🔗 Affiliate Links & Codes
📊 Affiliate Dashboard
🤝 Referral Codes
💯 Leaderboard Data ⛓️ Tokens 🌟 Points 🔈 Volume
⛓️ Tokens
🌟 Points
🔈 Volume
🙋 Individual Rewards
📊 Referred Metrics
📱 Verifying X Follows
📊 Whitelabel TVL & APR
🪙 Claim Flow Integration
🎁 Public Claimable Rewards
🤙 Claiming Onchain Rewards
🪂 Airdrop Distributor
📢 Managing Audiences
📜 Terms & Conditions
🆘 Troubleshooting
⚠️ Error Handling
✈️ SDK Migration (5.x → 7.x)
🗂️ API Endpoint Directory
Tutorials 🎯 Referral Program with Token Rewards 🌟 Points Program with Leaderboard 💧 Incentivize DeFi Liquidity Providers
🎯 Referral Program with Token Rewards
🌟 Points Program with Leaderboard
💧 Incentivize DeFi Liquidity Providers
Protocol Reference ⛓️ Smart Contracts (EVM) ⛓️ SVM Programs (Solana) 🧵 Subgraphs
⛓️ Smart Contracts (EVM)
⛓️ SVM Programs (Solana)
🧵 Subgraphs
Resources 🔗 Main Links 📋 Changelog
🔗 Main Links
📋 Changelog
Developer Guide
💯 Leaderboard Data
Retrieve and display leaderboard rankings for your incentive programs. Fuul provides five leaderboard types:
Tokens
getPayoutsLeaderboard
Onchain token rewards earned
Points
getPointsLeaderboard
Point rewards earned
Volume
getVolumeLeaderboard
Trading/transaction volume generated
Revenue
getRevenueLeaderboard
Revenue generated, e.g. fees
Referred users
getReferredUsersLeaderboard
Number of users referred ( GET /v1/leaderboard/referred )
getReferredUsersLeaderboard is the one leaderboard that does not sit under /v1/payouts . Its endpoint is GET /v1/leaderboard/referred .
Leaderboard data is updated hourly. Recent conversions and payouts will appear within a maximum of one hour.
Common parameters
Filters are not uniform across the five methods. Check the "Supported by" column before passing one:
currency_address
string
Required on Tokens · optional on Volume, Revenue
Token contract address on the payout chain
user_identifier
Tokens, Points, Volume, Revenue
Filter to a specific user (for individual rewards)
identifier_type
'evm_address' , 'solana_address' , 'sui_address' , 'xrpl_address' , 'stellar_address' , 'email'
user_type
Tokens, Volume, Revenue
'affiliate' or 'end_user' (omit for all)
fields
Tokens, Points
Comma-separated extra fields: 'tier,referred_volume,enduser_volume,enduser_revenue,referred_users'
conversion_external_ids
number[]
Array of conversion IDs to filter by
page / page_size
number
All
Pagination, page_size max 100
Two exceptions worth knowing before you write the call:
getPayoutsLeaderboard requires currency_address . Omitting it is a TypeScript error.
getPointsLeaderboard does not accept user_type , from , to , currency_address , or conversion_external_ids . Points are ranked across the whole program.
getReferredUsersLeaderboard accepts page and page_size only — no user or conversion filters.
Leaderboard responses are paginated. Use page and page_size (max 100 per page) to retrieve the full leaderboard — e.g., page 1 returns ranks 1–100, page 2 returns ranks 101–200, and so on.
Last updated 1 month ago