osrs-data-hub
Leaderboards

Gains leaderboards

GET
/leaderboards/gains

The guild page’s gains leaderboards over the accounts whose stats the key may read: the top 10 per skill. Default period=day.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from the hub’s API keys page.

In: header

Query Parameters

skill?string

One skill, case-insensitive (overall works). Without it: Overall first, then every skill anyone gained XP in.

Length1 <= length
period?string

day = since local midnight in the key creator’s time zone; week/month = the last 7/30 days. Default day.

Value in

  • "day"
  • "week"
  • "month"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/leaderboards/gains"
{  "data": {    "period": "day",    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z",    "leaderboards": [      {        "skill": "string",        "entries": [          {            "rank": 1,            "account": {              "id": "string",              "name": "string"            },            "gain": 0          }        ]      }    ]  },  "meta": {    "generated_at": "2019-08-24T14:15:22Z"  }}