Introduction

Current Github Action build status. Package dependancy status. Total downloads. npm package version. Released under the MIT license.

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

Requests are made using the Got library and will not work in a browser. This was a conscious decision resulting from the limitation that the APIs Jagex expose do not allow CORS so browsers would just block the request. You'd need to use a server as a proxy still.

Installation

npm install runescape-api
# OR
yarn add runescape-api

Usage

The implementation offers functionality to interact with the following:

More, detailed examples can be provided on the respective documentation pages, a complete summary of the documentation pages can be found on the GitHub Repository.