Referral Scheme
Getting Referral Earnings
Remember you can always earn referral commissions without using the API.
Just share your referral link https://ordinalsbot.com/?ref=your-referral-code with your community, visitors or followers and you'll automatically earn referral commissions from the inscriptions they make.
Use this endpoint to check earnings for your referrals code:
Get Referral Status
GET https://api.ordinalsbot.com/referrals
Check referral earning status.
Your referral earning is calculated as
paidCount * baseFee * 0.15
(e.g. 100 * 9000 (sats) * %15 commission)
Query Parameters
referral*
String
Your referral code
address*
String
Your bitcoin address that you've set for payouts
{
"address":"bc1qxxx",
"orderCount":962, // how many orders were created with your reflink
"paidCount":305 // how many paid orders were processed.
}Saving Referral Code
Use this endpoint to set a unique referral code for yourself.
Set referral code and payout address
POST https://api.ordinalsbot.com/referrals
Use this endpoint to set your referral code and payout address. Your address allows you to query your referral earnings.
Request Body
referral*
String
Your unique referral code
address*
String
Your bitcoin address that you want to receive payouts to.
{
"status":"ok" // your information is saved.
}Last updated