Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

referral

POST/infotype referral

Render the Referral page: referrer, rewards, referrer stage.

Request body
typestringrequired
userstringrequired

User address.

exchangeIdinteger · int32nullableoptional

Optional channel filter. Omit or `0` for the default platform channel.

Request example
curl -X POST https://rpc.txflow-testnet.xyz/info \
  -H "Content-Type: application/json" \
  -H "x-api-version: 2026-08-16" \
  -d '{
  "type": "referral",
  "user": "0x0000000000000000000000000000000000000000"
}'
Try it
POST https://rpc.txflow-testnet.xyz/info
Response · ReferralResponse 200
codeinteger

`0` on success.

dataReferralResponse
claimedRewardsstring
cumVlmstring
referrerStateReferrerState
unclaimedRewardsstring
referredByanyOf
successboolean

`false` on error, with `code` set and the text in `message` instead of `data`.

Response example
{
  "success": true,
  "code": 0,
  "data": {
    "referredBy": {
      "referrer": "",
      "code": ""
    },
    "cumVlm": "",
    "unclaimedRewards": "",
    "claimedRewards": "",
    "referrerState": {
      "stage": "ready",
      "data": {
        "code": "",
        "nReferrals": 0,
        "referralStates": [
          {
            "cumVlm": "",
            "cumRewardedFeesSinceReferred": "",
            "cumFeesRewardedToReferrer": "",
            "timeJoined": 1700000000000,
            "user": "0x0000000000000000000000000000000000000000"
          }
        ]
      }
    }
  }
}