Skip to main content
GET
https://backend.themarketunited.com
/
referral
/
summary
Get referral summary
curl --request GET \
  --url https://backend.themarketunited.com/referral/summary \
  --header 'Authorization: Bearer <token>'
{
  "code": "<string>",
  "rewardBps": 3000,
  "refereeCount": 123,
  "referees": [
    {
      "address": "<string>",
      "username": "<string>",
      "referredAt": "2023-11-07T05:31:56Z",
      "volumeUsd": 123,
      "feesUsd": 123,
      "rewardUsd": 123
    }
  ],
  "totals": {
    "downlineVolumeUsd": 123,
    "lifetimeRewardUsd": 123,
    "currentEpochRewardUsd": 123,
    "paidUsd": 123,
    "unpaidUsd": 123
  },
  "epoch": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

SIWE access token returned by POST /auth/verify.

Response

200 - application/json

Referral summary returned.

code
string
rewardBps
integer

Referrer's share of referees' platform fees, in basis points.

Example:

3000

refereeCount
integer
referees
object[]
totals
object
epoch
object