Skip to content

Index Lite

Overview

This API gives you all current statistics and ranks for a specific player, as long as they exist in this instance.

URL: https://secure.runescape.com/m=hiscore/index_lite.json?player=NAME - replace NAME with the display name of the player.

For other instances, replace hiscore with one of the names listed on Instances.

Example

{
    "name": "Mod Example",
    "skills": [
        {
            "id": 0,
            "name": "Overall",
            "rank": 949037,
            "level": 1811,
            "xp": 45998500
        },
        {
            "id": 1,
            "name": "Attack",
            "rank": 1496199,
            "level": 79,
            "xp": 1874228
        },
        // ...
    ],
    "activities": [
        {
            "id": 0,
            "name": "Grid Points",
            "rank": -1,
            "score": 0
        },
    ]
}

Format

Missing players will return a HTTP 404 (Not Found) status code. Other internal errors will return a HTTP 500 status code.

If information for a player is found, you'll receive a HTTP 200 (OK) along with the following response.

Top-level response

Field Type Description
name String Display name for this player, as provided in the URL - may not match the actual case of the name
skills Array Array of skill objects, representing this player's stats in Overall and Skill tables
activities Array Array of activity objects, representing this player's stats in activities

Skill object

Field Type Description
id Integer Index of this skill (0 for "Overall", 1 and up for actual skills)
name String Name of this skill
rank Integer Position of this player (starting at 1) in this table, or -1 if they are not ranked
level Integer Level the player has in this skill (or total level, for "Overall")
xp Integer XP the player has in this skill (or total XP, for "Overall")
death Death record Optional, Hardcore Ironman instances only - If this player has lost their HCIM status, describes the circumstances

In some older Hiscore records, level and xp will be set to -1, which signifies that no data is available - see Partial data for an explanation.

Activity object

Field Type Description
id Integer Index of this activity, starting at 0
name String Name of this activity
rank Integer Position of this player (starting at 1) in this table, or -1 if they are not ranked
score Integer Value - exact meaning depends on the activity (points, score, kill count, etc.)

In some older Hiscore records, score will be set to -1, which signifies that no data is available - see Partial data for an explanation.

Despite the name, id is not guaranteed to stay the same over time. New activities are often added in the middle of the list which will increase the id for existing ones. You should use name to distinguish activities over time.

Activities for special game modes (e.g. Grid Points, League Points) will always be included in the list, even on instances where they're not relevant.

Death record object

This object is only present in the Skill object with ID 0 and name "Overall" on the Hardcore Ironman instances, and only for players which have been recorded as dead.

Field Type Description
timeStamp Integer Timestamp of the death, in milliseconds since the Unix epoch
worldID Integer World ID where the player died
location Integer Coordinates where the player died (bit-packed: (level << 28) | (x << 14) | z), or -1 if data unavailable
npcKiller Integer ID of the NPC that killed the player, or -1 if unavailable
playerKiller Integer Always -1
deathReason Integer ID of the reason for this player's death, or -1 if unavailable
language String Language code of the text descriptions, usually EN
locationDescription String Sentence fragment describing where in the game world the player died, or an empty string if unavailable
deathDescription String Sentence fragment describing how the player died, or an empty string if unavailable

Old School deaths do not include any data for the killer, reason or description fields.

Example: RuneScape 
{
  "name": "testacct1",
  "skills": [
    {
      "id": 0,
      "name": "Overall",
      "rank": 70,
      "level": 2909,
      "xp": 916252010,
      "death": {
        "timeStamp": 1594717976929,
        "worldID": 48,
        "location": 805306368,
        "npcKiller": -1,
        "playerKiller": -1,
        "deathReason": -1,
        "language": "EN",
        "locationDescription": "Wilderness, ",
        "deathDescription": "fighting in PvP combat against testacct2."
      }
    },
    // ...
  ]
}
Example: Old School 
{
  "name": "testacct3",
  "skills": [
    {
      "id": 0,
      "name": "Overall",
      "rank": 6,
      "level": 2376,
      "xp": 312826844,
      "death": {
        "timeStamp": 1782380139450,
        "worldID": 141,
        "location": 207143015,
        "npcKiller": -1,
        "playerKiller": -1,
        "deathReason": -1,
        "language": "EN",
        "locationDescription": "",
        "deathDescription": ""
      }
    },
    // ...
  ]
}