Get referral rewards earned by current user

Return list of referral rewards (KYB and volume bonuses) for the current user.

GET /api/v1/user/rewards

Get referral rewards earned by current user

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/user/rewards \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hevn.finance/api/v1/user/rewards"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hevn.finance/api/v1/user/rewards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "rewards": [
    {
      "id": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "refereeName": "<string>",
      "refereeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "currency": "USD"
    }
  ],
  "totalAmount": "<string>",
  "currency": "USD"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Query Parameters

limit · integer · default: 100

Required range: 1 <= x <= 500

cursor · string | null

Reserved for future pagination

Response

200

application/json

Successful Response

List of referral rewards earned by the current user.

rewards · RewardItem · object[] · required

Show child attributes

totalAmount · string · required

currency · string · default: USD