# osrs-wrapper

> A simple wrapper around the Old School Runescape API

Latest version **2.3.5** (published 2026-07-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install osrs-wrapper
pnpm add osrs-wrapper
yarn add osrs-wrapper
bun add osrs-wrapper
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.3.5 |
| Published | 2026-07-31 |
| First published | 2016-12-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | jeffreyhage@gmail.com |
| Maintainers | atjeff |
| Keywords | Old School Runescape, OSRS, API |

## Links

- npm: https://www.npmjs.com/package/osrs-wrapper
- Repository: https://github.com/atjeff/Osrs-Wrapper
- Homepage: https://github.com/atjeff/Osrs-Wrapper#readme
- Issues: https://github.com/atjeff/Osrs-Wrapper/issues
- npm.io page: https://npm.io/package/osrs-wrapper

## Recent versions

- 2.3.5 (latest) — 2026-07-31
- 2.3.4 — 2026-07-03
- 2.3.3 — 2026-02-27
- 2.3.2 — 2025-11-24
- 2.3.1 — 2025-09-02
- 2.3.0 — 2025-08-27
- 2.2.14 — 2025-08-26
- 2.2.13 — 2025-05-16
- 2.2.12 — 2025-03-17
- 2.2.11 — 2025-03-17
- 2.2.10 — 2025-02-05
- 2.2.9 — 2024-09-25
- 2.2.8 — 2024-08-29
- 2.2.7 — 2024-03-21
- 2.2.6 — 2024-01-25
- … 17 more at https://npm.io/package/osrs-wrapper/versions

## README

# Osrs-Wrapper
Simple wrapper around the [Old School Runescape](http://oldschool.runescape.com/) API

## Installation 
```
$ npm install --save osrs-wrapper
```

## Usage
This wrapper interacts with the following Old-School APIs:
* Hiscores
* Grand Exchange

## Api Reference
### **getHiscores**
```ts
import { getHiscores } from 'osrs-wrapper';

const stats = await getHiscores('Bald')
// { Overall: { rank: '94441', level: '1969', xp: '93090113' }, Attack: { rank: '226496', level: '91', xp: '6226771' } ... }
```

### **getExchangeStats**
```ts
import { getExchangeStats } from 'osrs-wrapper';

const itemStats = await getExchangeStats(4151);
// { id: 4151, name: 'Abyssal whip', description: 'A weapon from the abyss.', current: {  trend: 'neutral', price: '2.7m' } ... }
```

### **getExchangeTrendGraph**
```ts
import { getExchangeTrendGraph } from 'osrs-wrapper';

const itemGraph = await getExchangeTrendGraph(4151);
// { daily: { '1564099200000': 2534129, ... } average: { '1564099200000': 2564308, ... } }
```

## Examples
See `examples/`
```bash
bun run examples/item.ts
bun run examples/hiscores.ts
```

## License
`osrs-wrapper` is under the [MIT](http://opensource.org/licenses/MIT) license.

---
_Source: https://npm.io/package/osrs-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._