osrs-data-hub
Leaderboards

Loot leaderboard

GET
/leaderboards/loot

The period’s most valuable drops over the accounts whose events the key may read: loot and pk_loot events with a value, not on a special world, highest value_gp first. Each entry’s event is exactly what /events serves (with data.location removed the same way), though it can appear here a few seconds before the /events cursor serves it. Default period=day, limit=10 (at most 50).

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

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"
limit?string

Drops to return, 1 to 50. Default 10.

Match^\d{1,16}$

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/leaderboards/loot"
{  "data": {    "period": "day",    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z",    "entries": [      {        "rank": 1,        "event": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "type": "string",          "account": {            "id": "string",            "name": "string"          },          "occurred_at": "2019-08-24T14:15:22Z",          "received_at": "2019-08-24T14:15:22Z",          "value_gp": 0,          "item_id": 0,          "npc_id": 0,          "skill": "string",          "level": 0,          "tier": "string",          "points": 0,          "special_world": true,          "data": {            "property1": null,            "property2": null          },          "title": "string",          "line": "string"        }      }    ]  },  "meta": {    "generated_at": "2019-08-24T14:15:22Z"  }}