v1

latestOpenAPI 3.0.02026-07-267331140.7 KB
Rewards

Retrieve Rewards Information

Returns user's OG status, GNO balance of Safe, and calculated base cashback rate. Note that the cashbackRate returned does not include the +1% bonus for OG NFT holders - to get the total cashback rate, add 1% to the cashbackRate if isOg is true.

get/api/v1/rewards

Response

Successfully retrieved rewards information

isOgboolean required

Indicates if the user holds an OG NFT token. If true, the user gets an additional 1% cashback on top of the base cashbackRate.

gnoBalancenumber required

User's GNO token balance in their Safe account

cashbackRatenumber required

Base cashback rate calculated from GNO balance (0-4%). For OG NFT holders, add 1% to this rate to get the total cashback rate.

Example response

{
  "isOg": true,
  "gnoBalance": 10.5,
  "cashbackRate": 2.5
}