---
title: "Get referral information"
method: GET
path: "/api/v1/wallet/referral"
tags: ["Wallet"]
---

# Get referral information

`GET /api/v1/wallet/referral`

## Request

- Base URL: `https://backend.caspr.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://backend.caspr.ai/api/v1/wallet/referral`
- Auth: OAuth 2
  - Password
  - Token URL: `token`

Get user's referral code and statistics including total referrals and tokens earned

## Response `200`

Successful Response

- ReferralInfoResponse: Response for getting referral information.
  - `success` boolean, required
  - `referral_code` string, required: User's unique referral code
  - `total_referrals` integer, required: Total successful referrals
  - `total_tokens_earned` integer, required: Total tokens earned from referrals
  - `referral_link` string, required: Complete referral link to share

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/caspr/apis/casper-api.md) - [All operations](https://skmtc.dev/caspr/apis/casper-api/llms.txt) - [OpenAPI document](https://skmtc.dev/caspr/apis/casper-api/revisions/f9765e3aa00c?raw)