Sign in
referral-codes

Changed on

Return the user's referral code and stats.

Generation of new user referral codes is disabled, so this only serves codes that already exist.

get/v1/referral-codes/me/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token

Response

codestring required
referral_urlstring required
referred_countinteger required
total_earned_usdstring decimal required
earning_cap_usdstring decimal required
total_earnedstring decimal required
earning_capstring decimal required
credit_amountstring decimal required
referrer_credit_amountstring decimal required
is_eligible_for_creditsboolean required

Changes