Osrs-Wrapper

Simple wrapper around the Old School Runescape API

Installation

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

Usage

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

Api Reference

$3

`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' } ... }
`

$3


`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' } ... }
`

$3


`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 license.