PHPackages                             elbojoloco/runescape-hiscores - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. elbojoloco/runescape-hiscores

ActiveLibrary[API Development](/categories/api)

elbojoloco/runescape-hiscores
=============================

An easy-to-use wrapper for communicating with both the OSRS and RS3 hiscores.

v1.2.1(5y ago)12111MITPHPPHP ^7.1.0

Since Apr 20Pushed 5y ago1 watchersCompare

[ Source](https://github.com/elbojoloco/runescape-hiscores)[ Packagist](https://packagist.org/packages/elbojoloco/runescape-hiscores)[ RSS](/packages/elbojoloco-runescape-hiscores/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (1)Versions (6)Used By (0)

[![Packagist Version](https://camo.githubusercontent.com/520cf4fc217db546d4386aface03a49e71a182586a1c1aaeb6b82c09cd6e673b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f656c626f6a6f6c6f636f2f72756e6573636170652d686973636f726573)](https://packagist.org/packages/elbojoloco/runescape-hiscores)[![Packagist Downloads](https://camo.githubusercontent.com/70d87bb2dd439a86cade3e78121575207eaaa3b17d33de5e79cee1f9c69f4b69/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f656c626f6a6f6c6f636f2f72756e6573636170652d686973636f726573)](https://packagist.org/packages/elbojoloco/runescape-hiscores/stats)

Requirements
============

[](#requirements)

- PHP 7.1 or up

Installation
============

[](#installation)

- `composer require elbojoloco/runescape-hiscores`

Basic usage
===========

[](#basic-usage)

It's very easy to start getting data from the RS3 / OSRS hiscores. All you need to get all stats for a player is this line: (Make sure to `use Elbojoloco\RunescapeHiscores\Runescape;`)

- OSRS: `$player = Runescape::oldschool('Lynx Titan');`
- RS3: `$player = Runescape::rs3('le me');`

To dynamically pass a hiscore to use you should use the `get($type, $rsn)` method instead:

```
$hiscoreType = $_GET['hiscore_type'];
$rsn = $_GET['rsn'];

$player = Runescape::get($hiscoreType, $rsn);

```

`$type` will only accept the values `rs3` or `oldschool`, case-insensitive. The `$rsn` also must be at least 1 character, to prevent meaningless API calls.

You may also use the predefined constants on the `Elbojoloco\RunescapeHiscores\RunescapeClient` class:

```
Runescape::get(RunescapeClient::TYPE_OLDSCHOOL, 'Lynx Titan');
Runescape::get(RunescapeClient::TYPE_RS3, 'le me');

```

The Player object
=================

[](#the-player-object)

All 3 of the static methods `rs3()`, `oldschool()` and `get()` will return an instance of `Elbojoloco\RunescapeHiscores\Player`. This Player class provides some handy methods to interact with the hiscores data as show in these examples:

#### Retrieving the RSN

[](#retrieving-the-rsn)

- `$player->name()`

#### Retrieving the level of a skill, or multiple skills

[](#retrieving-the-level-of-a-skill-or-multiple-skills)

- `$player->level('Runecrafting')` // Returns level as a string
- `$player->level(['Runecrafting', 'Mining', 'Construction'])` // Returns an associative array of "skill" => "level"

#### Retrieving the experience of a skill, or multiple skills

[](#retrieving-the-experience-of-a-skill-or-multiple-skills)

- `$player->experience('Overall')` // Returns experience as a string
- `$player->experience(['Runecrafting', 'Mining', 'Construction'])` // Returns an associative array of "skill" => "experience"

#### Retrieving the rank for a skill, boss or minigame

[](#retrieving-the-rank-for-a-skill-boss-or-minigame)

- `$player->rank('Runecrafting')` // Returns rank as a string
- `$player->rank(['Runecrafting', 'Zulrah', 'Construction'])` // Returns an associative array of "stat" => "rank"

#### Retrieving all metrics of a skill, boss or minigame

[](#retrieving-all-metrics-of-a-skill-boss-or-minigame)

- `$player->stats('Overall')` // Returns a skill entry that contains "rank", "level" and "experience"
- `$player->stats('Zulrah')` // Returns a boss/minigame entry that contains "rank" and "count"
- `$player->stats(['Hitpoints', 'Strength'])` // Returns an array of skill entries
- `$player->miniGames(['Clue scrolls (beginner)', 'Vorkath'])` // Returns an array of bosses/minigames. For a full list of accepted keys please refer to [RunescapeClient.php](https://github.com/elbojoloco/runescape-hiscores/blob/master/src/RunescapeClient.php#L57).
- `$player->bosses()` is an alias for `$player->miniGames()`
- `$player->stats()` // Returns an array of all stat entries

Contributing
============

[](#contributing)

### Pull requests

[](#pull-requests)

Fork the repository and submit a pull request to the "master" branch. Please make sure to follow coding conventions displayed in the existing source.

### Issues

[](#issues)

Try to describe the issue in as much detail as possible and provide examples. General feedback is welcomed and much appreciated too :)

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 95.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~24 days

Total

5

Last Release

2117d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/7912315?v=4)[Lucas](/maintainers/elbojoloco)[@elbojoloco](https://github.com/elbojoloco)

---

Top Contributors

[![elbojoloco](https://avatars.githubusercontent.com/u/7912315?v=4)](https://github.com/elbojoloco "elbojoloco (21 commits)")[![Moelanz](https://avatars.githubusercontent.com/u/50054674?v=4)](https://github.com/Moelanz "Moelanz (1 commits)")

---

Tags

runescapeosrsrs3highscoreshiscores

### Embed Badge

![Health badge](/badges/elbojoloco-runescape-hiscores/health.svg)

```
[![Health](https://phpackages.com/badges/elbojoloco-runescape-hiscores/health.svg)](https://phpackages.com/packages/elbojoloco-runescape-hiscores)
```

###  Alternatives

[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[hubspot/api-client

Hubspot API client

23414.2M16](/packages/hubspot-api-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)