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 * serviceFee profit * 0.15

(e.g. 100 * 15000 (sats) * %15 commission)

Query Parameters

Name	Type	Description
referral*	String	Your referral code
address*	String	Your bitcoin address that you've set for payouts

200: OK Normal Response

{
    "address":"bc1qxxx",
    "orderCount":962, // how many orders were created with your reflink
    "paidCount":305 // how many paid orders were processed.
}

200: OK Error Response with Cause

{
    status: 'error', 
    error: 'error reason'
}

500: Internal Server Error Server side error

{
    status: 'error',
    reason: 'unable to check data'
}

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

Name	Type	Description
referral*	String	Your unique referral code
address*	String	Your bitcoin address that you want to receive payouts to.

200: OK Normal Response

{
    "status":"ok" // your information is saved.
}

200: OK Error Response with Cause

{
    status: 'error', 
    error: 'referral code already exists - pick another one'
}

500: Internal Server Error Server side error

{
    status: 'error',
    reason: 'unable to set data'
}

Get in touch for any questions regarding referral setup in our discord: https://discord.ordinalsbot.com