curl --request GET \
--url https://api-tbi.boost.xyz/v1/referrals/stats/{address}import requests
url = "https://api-tbi.boost.xyz/v1/referrals/stats/{address}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api-tbi.boost.xyz/v1/referrals/stats/{address}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-tbi.boost.xyz/v1/referrals/stats/{address}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-tbi.boost.xyz/v1/referrals/stats/{address}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-tbi.boost.xyz/v1/referrals/stats/{address}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-tbi.boost.xyz/v1/referrals/stats/{address}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": {
"chainId": 123,
"campaignIndex": 4503599627370495
},
"referrer": "<unknown>",
"status": "estimated",
"refereeCount": 4503599627370495,
"refereesEarned": "<string>",
"uncappedAmount": "<string>",
"amount": "<string>",
"referralPool": "<string>",
"claimWindowDuration": "<string>",
"claimWindowEnd": "<string>",
"claimTxHash": null,
"claimedAt": "<string>",
"rewardToken": {
"address": "<unknown>",
"decimals": 4503599627370495,
"symbol": "<string>"
}
}
]
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}Get referrer earnings per campaign
Per-campaign referral earnings for a referrer. Rows are status ‘estimated’ while a campaign is live (referees’ current accrued rewards with the referral rate applied, then scaled pro-rata into the referral pool against every referrer’s share — amount is the projected payout) and ‘final’ once the post-finalize entitlement exists (amount is the committed pool-capped payout). Every row carries the distributor’s referralPool and claimWindowDuration (null without a referral program), claimWindowEnd (unix seconds, null until the referral root is published), and claimTxHash/claimedAt from the indexed on-chain ReferralClaimed event, null until the referrer has claimed.
curl --request GET \
--url https://api-tbi.boost.xyz/v1/referrals/stats/{address}import requests
url = "https://api-tbi.boost.xyz/v1/referrals/stats/{address}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api-tbi.boost.xyz/v1/referrals/stats/{address}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-tbi.boost.xyz/v1/referrals/stats/{address}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-tbi.boost.xyz/v1/referrals/stats/{address}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-tbi.boost.xyz/v1/referrals/stats/{address}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-tbi.boost.xyz/v1/referrals/stats/{address}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": {
"chainId": 123,
"campaignIndex": 4503599627370495
},
"referrer": "<unknown>",
"status": "estimated",
"refereeCount": 4503599627370495,
"refereesEarned": "<string>",
"uncappedAmount": "<string>",
"amount": "<string>",
"referralPool": "<string>",
"claimWindowDuration": "<string>",
"claimWindowEnd": "<string>",
"claimTxHash": null,
"claimedAt": "<string>",
"rewardToken": {
"address": "<unknown>",
"decimals": 4503599627370495,
"symbol": "<string>"
}
}
]
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}Headers
Optional partner attribution reference ID. Values are manually assigned by Boost and must be at most 128 characters.
1 - 128^[A-Za-z0-9][A-Za-z0-9._:-]*$Path Parameters
EVM address. Responses normalize addresses to lowercase.
Query Parameters
Reward chain ID.
x <= 9007199254740991Response
Referral stats
Show child attributes
Show child attributes