Player Data API

Overview¶

This API allows you to retrieve gameplay information concerning a specific player. Use query parameters to indicate which types of data you need.

URL: https://secure.runescape.com/m=adventurers-log/api/v1/playerData/NAME?includeQuests=true - replace NAME with the display name of the player.

Tip

If you only need skill XP/level information, consider using the Hiscore Index Lite API instead. It updates slightly less often, but responds faster.

Supported Types¶

You can combine any of the following types depending on what info you need. You must specify at least one; otherwise, you'll receive a NO_DATA_TYPES_SPECIFIED error.

Parameter	What you get
`includeSkills=true`	Current XP and level for all skills
`includeQuests=true`	Quest objects and quest point info

Example (all types enabled)¶

{
    "skills": {
        "attack": {
            "fine_xp": 8137022,
            "level": 70
        },
        // ...
    },
    "quests": {
        "257": {
            "difficulty": 0,
            "eligible": true,
            "members": false,
            "title": "Cook's Assistant",
            "qp": 1,
            "status": "COMPLETED"
        },
        "289": {
            "difficulty": 3,
            "eligible": false,
            "members": true,
            "title": "Mourning's End Part I",
            "qp": 2,
            "status": "NOT_STARTED"
        },
        "307": {
            "difficulty": 2,
            "eligible": false,
            "members": true,
            "title": "Recipe for Disaster: Defeating the Culinaromancer",
            "qp": 1,
            "status": "STARTED"
        },
        // ...
    },
    "name": "Mod Example",
    "qp_max": 476,
    "qp": 235
}

Format¶

Errors will return an error response and an appropriate HTTP status code; see the Adventurer's Log Error Handling section for more details.

Top-level response¶

Required Type	Field	Type	Description
(Always present)	`name`	String	Canonical display name for this player
`includeSkills`	`skills`	Object	Map from skill names to skill objects
`includeQuests`	`qp`	Integer	Amount of quest points attained by this player, calculated using the in-game logic
`includeQuests`	`qp_max`	Integer	Maximum amount of quest points that's currently possible to obtain
`includeQuests`	`quests`	Object	Map from internal quest IDs to quest objects

Skill object¶

Field	Type	Description
`fine_xp`	Integer	Amount of XP that the player has in the skill, multiplied by 10 (therefore, a skill at exactly level 10 will have `11540` in this value)
`level`	Integer	Level that the player has reached in the skill

Skill names¶

These are the internal names used in this API: attack, defence, strength, hitpoints, ranged, prayer, magic, cooking, woodcutting, fletching, fishing, firemaking, crafting, smithing, mining, herblore, agility, thieving, slayer, farming, runecraft, hunter, construction, summoning, dungeoneering, divination, invention, archaeology, necromancy

Quest object¶

Field	Type	Description
`title`	String	Name of the quest, subquest or miniquest
`difficulty`	Integer	Rated difficulty of the quest
`members`	Boolean	Whether this quest is restricted to RuneScape members
`qp`	Integer	How many quest points are awarded if this quest is complete
`eligible`	Boolean	Whether this player meets the requirements to do this quest
`status`	String	Either `NOT_STARTED`, `STARTED` or `COMPLETED` depending on this player's progress in the quest

Difficulty values¶

Value	Name
0	Novice
1	Intermediate
2	Experienced
3	Master
4	Grandmaster
250	Multi (Indicates the 'parent' nodes for grouped quests such as Recipe for Disaster)

Update delays¶

This data will synchronise to Adventurer's Log when a player logs out, hops worlds, and at semi-regular intervals during gameplay.

The Adventurer's Log caches responses, so newly synchronised data may not be returned by the API for up to 10 minutes.

Miscellaneous notes¶

Quest Point calculation¶

It might seem like you can calculate a player's quest points by summing the qp field for all quests that are marked with status: "COMPLETED", but this doesn't work in all cases.

There are a number of special situations, including (but not limited to):

Sheep Shearer was downgraded to a miniquest in 2010, but players who completed it before then kept their 1QP.
Myths of the White Lands normally awards 2QP, but if you have 1QP from shearing sheep, then the Myths reward is reduced to 1QP.
Dimension of Disaster can be replayed. Doing this resets the status to "STARTED", but you still keep the QP from your initial completion.

The qp field in the top-level response uses the Quest Points value calculated when the player last logged into the game, so it will mirror the special logic implemented there.