Skip to content
Simple wrapper for RuneScape APIs written for node.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples Added property to players isMaxed that returns true or false if maxed… Aug 18, 2018
lib 2 spaces to 4 spaces Aug 19, 2018
test
.gitignore
.jshintrc
.npmignore update .gitignore, add .npmignore, and added a change log Sep 11, 2015
.travis.yml
CHANGELOG.md
LICENSE max LICENSE column length made to 70 Jun 2, 2015
README.md
index.js initial commit and first release(v1.0.1) Jun 2, 2015
package.json
yarn.lock update dependencies Dec 2, 2017

README.md

RuneScape API

Build Status Dependency Status

Introduction

runescape-api is an open-source wrapper, written in Node.js, that allows interaction with the various APIs available for the popular MMORPG RuneScape.

Installation

npm install runescape-api --save

Usage

The implementation offers functionality to interact with the following:

The example below explains how to gain access to the runescape-api library and fetch a beasts information.

var rsapi = require('runescape-api');

rsapi.rs.bestiary.beast(49).then(function(beast) {
    console.log(JSON.stringify(beast, null, 2));
}).catch(console.error);

Outputs:

{
  "animations": {
    "death": 17347,
    "attack": 17348
  },
  "slayercat": "Hellhounds",
  "xp": "344.4",
  "size": 2,
  "lifepoints": 3300,
  "weakness": "Slashing",
  "id": 49,
  "poisonous": false,
  "magic": 1,
  "attackable": true,
  "level": 92,
  "defence": 66,
  "description": "Hello, nice doggy...",
  "name": "Hellhound",
  "ranged": 1,
  "areas": [
    "Ardougne underground",
    "RuneScape Surface",
    "Forinthry Dungeon",
    "Taverley Dungeon",
    "Ancient cavern"
  ],
  "attack": 66,
  "aggressive": false,
  "members": false
}

More examples can be found in the examples folder.

License

runescape-api is under the MIT license, see the LICENSE file for the copyright information and licensing terms.

You can’t perform that action at this time.