RS3 Node

RS3 Node is a node based RuneMetrics wrapper for Runescape 3.

Installation

To install RS3-Node use the npm package manager.

npm i rs3-node

Usage

const rs3 = require("rs3-node");

rs3.getLevels('rsn') # returns players level
#[
#  { level: 62, xp: 3553949, rank: 687456, id: 14 },
#  { level: 62, xp: 3362679, rank: 730251, id: 6 },
#  { level: 61, xp: 3141904, rank: 766163, id: 1 },
#  { level: 57, xp: 2065469, rank: 749482, id: 10 },
#  { level: 57, xp: 2048712, rank: 928270, id: 3 },
#  { level: 57, xp: 2046348, rank: 666701, id: 12 },
#  { level: 54, xp: 1550495, rank: 536245, id: 17 },
#  { level: 53, xp: 1479939, rank: 810087, id: 7 },
#  { level: 51, xp: 1137238, rank: 808122, id: 13 },
#  { level: 50, xp: 1094075, rank: 604204, id: 20 },
#  { level: 50, xp: 1059842, rank: 617084, id: 18 },
#  { level: 49, xp: 936583, rank: 466980, id: 25 },
#  { level: 45, xp: 636154, rank: 795356, id: 5 },
#  { level: 44, xp: 604187, rank: 518978, id: 19 },
#  { level: 41, xp: 452331, rank: 1100622, id: 8 },
#  { level: 39, xp: 356118, rank: 667267, id: 24 },
#  { level: 39, xp: 348369, rank: 1030284, id: 11 },
#  { level: 33, xp: 184699, rank: 1254444, id: 2 },
#  { level: 33, xp: 183799, rank: 1272539, id: 0 },
#  { level: 30, xp: 134725, rank: 1076123, id: 4 },
#  { level: 30, xp: 134009, rank: 318080, id: 27 },
#  { level: 27, xp: 107303, rank: 859870, id: 16 },
#  { level: 27, xp: 107019, rank: 919837, id: 9 },
#  { level: 22, xp: 62850, rank: 759672, id: 22 },
#  { level: 19, xp: 42180, rank: 746796, id: 21 },
#  { level: 15, xp: 24510, rank: 854213, id: 15 },
#  { level: 8, xp: 8733, rank: 0, id: 23 },
#  { level: 1, xp: 0, rank: 0, id: 26 }
#]

rs3.getActivity('rsn') # returns players latest activity
#]
#  {
#    date: '07-May-2021 14:13',
#    details: 'I levelled my  Magic skill, I am now level 62.',
#    text: 'Levelled up Magic.'
#  },
#  {
#    date: '07-May-2021 13:58',
#    text: 'Levelled up Constitution.'
#  },
#  {
#    date: '07-May-2021 13:58',
#    details: 'I levelled my  Slayer skill, I am now level 50.',
#    text: 'Levelled up Slayer.'
#  },
#    date: '07-May-2021 13:51',
#    details: 'I levelled my  Defence skill, I am now level 61.',
#    text: 'Levelled up Defence.'
#  }
#]

rs3.getGeneralInfo('rsn') # returns players general information
#]
# {
#   magic: 63615,
#   questsstarted: 0,
#   totalskill: 1116,
#   questscomplete: 20,
#   questsnotstarted: 284,
#   totalxp: 2686407,
#   ranged: 204871,
#   name: 'redacted',
#   rank: '748,607',
#   melee: 1500298,
#   combatlevel: 76,
#   loggedIn: 'false'
# }
#]

Skill id's

0 = Attack
1 = Defence
2 = Strength
3 = Constitution (hp)
4 = Ranged
5 = Prayer
6 = Magic
7 = Cooking
8 = Woodcutting
9 = Fletching
10 = Fishing
11 = Firemaking
12 = Crafting
13 = Smithing
14 = Mining
15 = Herblore
16 = Agility
17 = Thieving
18 = Slayer
19 = Farming
20 = Runecrafting
21 = Hunter
22 = Construction
23 = Summoning
24 = Dungeoneering
25 = Divination
26 = Invention
27 = Archaeology