1️Get guild/scholar data

Query

gs_get_dashboard

Data field
Type
Note

authorization

String

service key to pass authentication

entity

String

service entity name

Header example

{
    "authorization": "oxalus_secret_Y68FurhtnvHp3IP0sRMzHQWY",
    "entity": "Oxalus"
}

Parameter

Data field
Type
Note

address

String

User's address

Success 200

Data field
Type
Note

data

Object

User data.

totalEarns

String

User total earnings.

totalMatches

Number

User total matches.

totalScholarships

Number

User total scholarships.

currentActiveScholarships

Number

User current active scholarships.

matchesStatistics

Object

Matches related data

win

Number

User total wins

lose

Number

User total losses

winRate

Number

User win rate

claimable

String

User totalEarns claimable

resultCode

String

anything different than GS:000 is failed request.

resultMessage

String

description of error or success.

Success-Response:

{
    "data": {
        "gs_get_dashboard": {
            "resultCode": "GS:000",
            "resultMessage": "Success",
            "data": {
                "totalEarns": "375500000000000000000",
                "totalMatches": 13,
                "matchesStatistics": {
                    "win": 11,
                    "lose": 2,
                    "winRate": 84.62
                },
                "totalScholarships": 35,
                "currentActiveScholarships": 1,
                "claimable": "73335000000000000000"
            }
        }
    }
}

Last updated