GET /referral/{address}
GET

/v1/referral/{address}

Get soldier profile

AuthNone — works without a key

Request

GEThttps://api.xrpl.to/v1/referral/rPsio2HNepLMEQFfY4uHC86wmZwud9q8Ut
Path parameterValueDescription
addressAn XRPL account, its r-address
curl 'https://api.xrpl.to/v1/referral/rPsio2HNepLMEQFfY4uHC86wmZwud9q8Ut'

Response

200Example response2 ms · just now · 1.1 KB · 58 lines
https://api.xrpl.to/v1/referral/rPsio2HNepLMEQFfY4uHC86wmZwud9q8Ut
{
  "success": true,
  "profile": {
    "_id": "rPsio2HNepLMEQFfY4uHC86wmZwud9q8Ut",
    "referralCode": "allthezenis",
    "referrer": null,
    "recruits": 3,
    "whales": 0,
    "tier2": 0,
    "streak": 1,
    "maxStreak": 1,
    "lastRecruit": 1773095838090,
    "badges": [
      "first_recruit"
    ],
    "tiers": [
      "Recruit"
    ],
    "activeTier": "Recruit",
    "volume": 0,
    "earnings": 0,
    "seasonRecruits": 3,
    "benefits": null,
    "createdAt": 1773018481241,
    "updatedAt": 1773095838090,
    "tokenBalance": 0,
    "tokenBalanceCheckedAt": 1784551391109,
    "tier": "Recruit",
    "tierData": {
      "id": "recruit",
      "min": 0,
      "name": "Recruit",
      "share": 0.5
    },
    "share": 0.5,
    "shareBreakdown": {
      "tierShare": 0.5,
      "badgeBonus": 0,
      "volumeBonus": 0,
      "streakBonus": 0,
      "holdingBonus": 0,
      "total": 0.5,
      "capped": false
    },
    "nextTier": {
      "id": "private",
      "min": 5,
      "name": "Private",
      "share": 0.5,
      "needed": 2
    },
    "streakStatus": {
      "tier": "none",
      "label": "No Streak"
    },
    "recruitBenefitDays": 60
  }
}

What it does

Get soldier profile

OpenAPI