GitLab

!1 (merged) adds support for ironman hiscores on RS3 and OSRS but didn't add docs for it. Documentation should be added here, as well as a help page on the wiki itself.

Draft help page (Help:RsHiScores + some redirects)

'''RsHiScores''' provides the <code>#hs</code> parser function for accessing a user's hiscore data which can be used in wikitext templates or JavaScript calculators.

== Usage ==
<pre>
{{#hs:API|NAME|SKILL|TYPE}}
</pre>

* <code>API</code>: The HiScores [[Application programming interface|API]] to use. See [[#APIs]] for more details.
* <code>NAME</code>: The name of the player to get data for.
* <code>SKILL</code>: The skill to get data for. If not specified the raw data from the API will be returned. For more details see [[#RS3 Skills]] or [[#OSRS Skills]].
* <code>TYPE</code>: The type of data to return. See [[#Types]] for more details.

If something went wrong, an error will be returned. See [[#Errors]] for possible errors.

== API ==
The following APIs are supported

* <code>rs3</code>: The standard HiScores for RuneScape 3.
* <code>rs3-ironman</code>: Ironman HiScores for RuneScape 3.
* <code>rs3-hardcore</code>: Hardcore Ironman HiScores for RuneScape 3.
* <code>osrs</code>: The standard HiScores for Old School RuneScape.
* <code>osrs-ironman</code>: Ironman HiScores for Old School RuneScape.
* <code>osrs-ultimate</code>: Ultimate Ironman HiScores for Old School RuneScape.

== RS3 Skills ==

{| class="wikitable"
! Number
! Skill/Activity
|-
| -1
| Returns the raw data. (default)
|-
| 0
| Overall
|-
| 1
| Attack
|-
| 2
| Defence
|-
| 3
| Strength
|-
| 4
| Constitution
|-
| 5
| Ranged
|-
| 6
| Prayer
|-
| 7
| Magic
|-
| 8
| Cooking
|-
| 9
| Woodcutting
|-
| 10
| Fletching
|-
| 11
| Fishing
|-
| 12
| Firemaking
|-
| 13
| Crafting
|-
| 14
| Smithing
|-
| 15
| Mining
|-
| 16
| Herblore
|-
| 17
| Agility
|-
| 18
| Thieving
|-
| 19
| Slayer
|-
| 20
| Farming
|-
| 21
| Runecrafting
|-
| 22
| Hunter
|-
| 23
| Construction
|-
| 24
| Summoning
|-
| 25
| Dungeoneering
|-
| 26
| Divination
|-
| 27
| Invention
|-
| 28
| Bounty Hunter
|-
| 29
| Bounty Hunter Rogue
|-
| 30
| Dominion Tower
|-
| 31
| The Crucible
|-
| 32
| Castle Wars Games
|-
| 33
| B.A. Attackers
|-
| 34
| B.A. Defenders
|-
| 35
| B.A. Collectors
|-
| 36
| B.A. Healers
|-
| 37
| Duel Tournament
|-
| 38
| Mobilising Armies
|-
| 39
| Conquest
|-
| 40
| Fist of Guthix
|-
| 41
| GG: Resource Race
|-
| 42
| GG: Athletics
|-
| 43
| WE2: Armadyl Lifetime Contribution
|-
| 44
| WE2: Bandos Lifetime Contribution
|-
| 45
| WE2: Armadyl PvP Kills
|-
| 46
| WE2: Bandos PvP Kills
|-
| 47
| Heist Guard Level
|-
| 48
| Heist Robber Level
|-
| 49
| CFP: 5 Game Average
|-
| 50
| AF15: Cow tipping
|-
| 51
| AF15: Rat kills after miniquest
|}

== OSRS Skills ==
{| class="wikitable"
! Number
! Skill/Activity
|-
| -1
| Returns the raw data. (default)
|-
| 0
| Overall
|-
| 1
| Attack
|-
| 2
| Defence
|-
| 3
| Strength
|-
| 4
| Hitpoints
|-
| 5
| Ranged
|-
| 6
| Prayer
|-
| 7
| Magic
|-
| 8
| Cooking
|-
| 9
| Woodcutting
|-
| 10
| Fletching
|-
| 11
| Fishing
|-
| 12
| Firemaking
|-
| 13
| Crafting
|-
| 14
| Smithing
|-
| 15
| Mining
|-
| 16
| Herblore
|-
| 17
| Agility
|-
| 18
| Thieving
|-
| 19
| Slayer
|-
| 20
| Farming
|-
| 21
| Runecrafting
|-
| 22
| Hunter
|-
| 23
| Construction
|-
| 24
| Clue Scrolls (easy)
|-
| 25
| Clue Scrolls (medium)
|-
| 26
| Clue Scrolls (all)
|-
| 27
| Bounty Hunter - Rogue
|-
| 28
| Bounty Hunter - Hunter
|-
| 29
| Clue Scrolls (hard)
|-
| 30
| Last Man Standing - Rank
|-
| 31
| Clue Scrolls (elite)
|-
| 32
| Clue Scrolls (master)
|}

== Types ==
The following types are supported:

* <code>0</code>: The player's rank in the selected skill or activity.
* <code>1</code>: (Default) The player's level in the selected skill or score in selected activity.
* <code>2</code>: (Skills only) The player's experience in the selected skill.

== Errors ==
If an error occurs, the page containing the error will be added to [[:Category:Pages with RSHiScores errors]].

The following errors can be returned:

* No player name entered.
* Too many players requested. No more than 2 are allowed.
* Failed to retrieve player data. Try again later.
    * This indicates that a HTTP error occurred and may be caused by the wiki making too many requests and is temporarily blocked. 
* The API requested does not exist
    * See above for the valid APIs.
* Player &apos;''playername''&apos; does not exist.
* The skill requested does not exist.
    * See [[#RS3 Skills]] or [[#OSRS Skills]] for the known valid skills.
* The type requested does not exist.
    * See [[#Types]] for the valid types.