# Introduction

[![Current Github Action build status.](https://github.com/astrect/runescape-api/workflows/status/badge.svg?color=005cc5)](https://github.com/astrect/runescape-api/actions?workflow=status) [![Package dependancy status.](https://img.shields.io/librariesio/release/npm/runescape-api)](https://www.npmjs.org/package/runescape-api) [![Total downloads.](https://img.shields.io/npm/dt/runescape-api?color=005cc5)](https://www.npmjs.org/package/runescape-api) [![npm package version.](https://img.shields.io/npm/v/runescape-api.svg?color=005cc5)](https://www.npmjs.org/package/runescape-api) [![Released under the MIT license.](https://img.shields.io/badge/license-MIT-blue.svg?color=005cc5)](https://github.com/astrect/runescape-api/blob/master/LICENSE)

`runescape-api` is an open-source wrapper, written in [Node.js](https://nodejs.org), that allows interaction with the various APIs available for the popular MMORPG [RuneScape](http://www.runescape.com).

### Installation

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

### Usage

The implementation offers functionality to interact with the following:

* [Bestiary](https://astrect.gitbook.io/runescape-api/docs/bestiary)
* [Clan](https://astrect.gitbook.io/runescape-api/docs/clan)
* [Grand Exchange](https://astrect.gitbook.io/runescape-api/docs/grandexchange)
* [Hiscores](https://astrect.gitbook.io/runescape-api/docs/hiscores)
* [Miscellaneous](https://astrect.gitbook.io/runescape-api/docs/miscellaneous)
* [RuneMetrics](https://astrect.gitbook.io/runescape-api/docs/runemetrics)
* [Oldschool](https://astrect.gitbook.io/runescape-api/docs/osrs)
  * [Grand Exchange](https://astrect.gitbook.io/runescape-api/docs/osrs/grandexchange)
  * [Hiscores](https://astrect.gitbook.io/runescape-api/docs/osrs/hiscores)

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](https://github.com/astrect/runescape-api/blob/master/SUMMARY.md).