Get User Points By Realm

This API endpoint retrieves the points of a user within a specific realm. The user can be identified either by their email or wallet address.

Endpoint

URL: https://beta.dequest.io/api/v2/b2b/realm/points

Method: GET

Authentication: x-api-key

Query Parameters

• email (optional): The email of the user whose points you want to retrieve. Must be a valid email address.
• walletAddress (optional): The wallet address of the user whose points you want to retrieve.
• gmail (optional): The email associated with the google account connected by the user must necessarily end with @gmail.com.

Note: You must provide either email or walletAddress or gmail, but not both. The parameters are mutually exclusive.

Response

The API will return the total points earned by the user in the specified realm.

Successful Response

• Status Code: 200 OK

• Body:

  {
      "ok": true,
      "result": {
          "earned": 10796,
          "userId": "244687be-e024-4de9-8612-f323f381efa3",
          "username": "Berserk",
          "badgesCount": 2,
          "badges": [
              {
                  "name": "Illuvitars",
                  "image": "<https://stage-dequest.fra1.digitaloceanspaces.com/sbt/1e706ff5-588c-40ab-aa6a-6165245da0fd/image.png>"
              },
              {
                  "name": "Illuvium PB2",
                  "image": "<https://stage-dequest.fra1.digitaloceanspaces.com/sbt/be6c91cf-2ce0-41b1-8fb5-0576595de87f/image.png>"
              }
          ]
      }
  }
  

  • earned: The number of points the user has earned in the realm. If no points are found, this will be 0.

Error Responses

• User Not Found:

  • Status Code: 404 Not Found

  • Body:

    {
        "ok": false,
        "code": 404000,
        "data": null,
        "msg": "User not found"
    }
    

• Invalid Parameters:

  • Status Code: 400 Bad Request

  • Body:

    {
        "ok": false,
        "code": 400000,
        "data": [
            {
                "reason": "object.xor"
            }
        ],
        "msg": "Validation error"
    }
    

• Unauthorized:

  • Status Code: 401 Unauthorized

  • Body:

    {
        "ok": false,
        "code": 401000,
        "data": null,
        "msg": "Missing authentication"
    }
    
    // or
    
    {
        "ok": false,
        "code": 401000,
        "data": null,
        "msg": "Invalid API KEY"
    }