UNPKG

11 kBMarkdownView Raw
1<h1 align="center">
2 (Unofficial) RuneScape API Client
3</h1>
4
5<p align="center">
6 <a href="https://github.com/pqt/runescape-api/actions?workflow=status">
7 <img src="https://github.com/pqt/runescape-api/workflows/status/badge.svg?color=005cc5" alt="Current Github Action build status." />
8 </a>
9 <a href="https://www.npmjs.org/package/runescape-api">
10 <img src="https://img.shields.io/librariesio/release/npm/runescape-api" alt="Package dependancy status." />
11 </a>
12 <a href="https://www.npmjs.org/package/runescape-api">
13 <img src="https://img.shields.io/npm/dt/runescape-api?color=005cc5" alt="Total downloads." />
14 </a>
15 <a href="https://www.npmjs.org/package/runescape-api">
16 <img src="https://img.shields.io/npm/v/runescape-api.svg?color=005cc5" alt="npm package version." />
17 </a>
18 <a href="https://github.com/pqt/runescape-api/blob/master/LICENSE">
19 <img src="https://img.shields.io/badge/license-MIT-blue.svg?color=005cc5" alt="Released under the MIT license." />
20 </a>
21</p>
22
23## Installation
24
25```bash
26npm install runescape-api
27# OR
28yarn add runescape-api
29```
30
31## Usage
32
33### RuneScape
34
35<details>
36 <summary>Clan</summary>
37
38---
39
40**Members**
41
42```js
43const { clan } = require("runescape-api")
44
45clan.members("Royal 58").then(members => {
46 console.log(members)
47})
48```
49
50</details>
51
52<details>
53 <summary>Hiscores</summary>
54
55---
56
57**Player**
58
59```js
60const { hiscores } = require("runescape-api")
61
62hiscores.player("Zezima").then(zezima => {
63 console.log(zezima)
64
65 /**
66 * Player {
67 * name: 'Zezima',
68 * activities: {
69 * bounty_hunters: { rank: -1, count: -1 },
70 * bh_rogues: { rank: -1, count: -1 },
71 * dominion_tower: { rank: 131, count: 26444969 },
72 * the_crucible: { rank: -1, count: -1 },
73 * castle_wars_games: { rank: -1, count: -1 },
74 * ba_attackers: { rank: 2534, count: 4285 },
75 * ba_defenders: { rank: 2358, count: 4161 },
76 * ba_collectors: { rank: 1737, count: 4354 },
77 * ba_healers: { rank: 3085, count: 4405 },
78 * duel_tournament: { rank: 1070, count: 1944 },
79 * mobilising_armies: { rank: 382, count: 552 },
80 * conquest: { rank: 19118, count: 1258 },
81 * fist_of_guthix: { rank: -1, count: -1 },
82 * gg_resource_race: { rank: 5791, count: 631 },
83 * gg_athletics: { rank: 18337, count: 605 },
84 * we2_armadyl_lifetime_contribution: { rank: 36444, count: 563812 },
85 * we2_bandos_lifetime_contribution: { rank: -1, count: -1 },
86 * we2_armadyl_pvp_kills: { rank: -1, count: -1 },
87 * we2_bandos_pvp_kills: { rank: -1, count: -1 },
88 * heist_guard_level: { rank: -1, count: -1 },
89 * heist_robber_level: { rank: -1, count: -1 },
90 * cfp_5_game_average: { rank: 569, count: 169 },
91 * af15_cow_tipping: { rank: -1, count: -1 },
92 * af15_rats_killed_after_the_miniquest: { rank: -1, count: -1 },
93 * runescore: { rank: 1051, count: 21045 },
94 * clue_scrolls_easy: { rank: 237, count: 968 },
95 * clue_scrolls_medium: { rank: 43681, count: 7 },
96 * clue_scrolls_hard: { rank: 44947, count: 77 },
97 * clue_scrolls_elite: { rank: 38877, count: 68 },
98 * clue_scrolls_master: { rank: 27320, count: 12 }
99 * },
100 * skills: {
101 * overall: { rank: 50, level: 2778, experience: 5400000000 },
102 * attack: { rank: 468, level: 99, experience: 200000000 },
103 * defence: { rank: 898, level: 99, experience: 200000000 },
104 * strength: { rank: 476, level: 99, experience: 200000000 },
105 * hitpoints: { rank: 391, level: 99, experience: 200000000 },
106 * ranged: { rank: 669, level: 99, experience: 200000000 },
107 * prayer: { rank: 239, level: 99, experience: 200000000 },
108 * magic: { rank: 583, level: 99, experience: 200000000 },
109 * cooking: { rank: 4, level: 99, experience: 200000000 },
110 * woodcutting: { rank: 217, level: 99, experience: 200000000 },
111 * fletching: { rank: 81, level: 99, experience: 200000000 },
112 * fishing: { rank: 460, level: 99, experience: 200000000 },
113 * firemaking: { rank: 249, level: 99, experience: 200000000 },
114 * crafting: { rank: 220, level: 99, experience: 200000000 },
115 * smithing: { rank: 253, level: 99, experience: 200000000 },
116 * mining: { rank: 421, level: 99, experience: 200000000 },
117 * herblore: { rank: 358, level: 120, experience: 200000000 },
118 * agility: { rank: 135, level: 99, experience: 200000000 },
119 * thieving: { rank: 3, level: 99, experience: 200000000 },
120 * slayer: { rank: 407, level: 120, experience: 200000000 },
121 * farming: { rank: 362, level: 120, experience: 200000000 },
122 * runecrafting: { rank: 183, level: 99, experience: 200000000 },
123 * hunter: { rank: 207, level: 99, experience: 200000000 },
124 * construction: { rank: 192, level: 99, experience: 200000000 },
125 * summoning: { rank: 175, level: 99, experience: 200000000 },
126 * dungeoneering: { rank: 640, level: 120, experience: 200000000 },
127 * divination: { rank: 178, level: 99, experience: 200000000 },
128 * invention: { rank: 166, level: 120, experience: 200000000 }
129 * }
130 * }
131 */
132})
133```
134
135**Avatar**
136
137```js
138const { hiscores } = require("runescape-api")
139
140hiscores.avatar("Paqt").then(avatar => {
141 console.log(avatar)
142
143 /**
144 * https://secure.runescape.com/m=avatar-rs/avatar.png?id=25260020
145 */
146})
147```
148
149</details>
150
151<details>
152 <summary>RuneMetrics</summary>
153
154---
155
156**Profile**
157
158```js
159const { runemetrics } = require("runescape-api")
160
161runemetrics.profile("Paqt").then(profile => {
162 console.log(profile)
163
164 /**
165 * {
166 * magic: 1388722,
167 * questsstarted: 18,
168 * totalskill: 1929,
169 * questscomplete: 132,
170 * questsnotstarted: 143,
171 * totalxp: 73706113,
172 * ranged: 4177540,
173 * activities: [
174 * {
175 * date: '24-Jan-2020 21:12',
176 * details: 'I have visited my Clan Citadel this week.',
177 * text: 'Visited my Clan Citadel.'
178 * },
179 * {
180 * date: '17-Jul-2019 07:04',
181 * details: 'I have visited my Clan Citadel this week.',
182 * text: 'Visited my Clan Citadel.'
183 * },
184 * {
185 * date: '17-Jul-2019 07:04',
186 * details: 'I levelled my Herblore skill, I am now level 61.',
187 * text: 'Levelled up Herblore.'
188 * },
189 * {
190 * date: '26-Jun-2019 04:41',
191 * details: 'I have visited my Clan Citadel this week.',
192 * text: 'Visited my Clan Citadel.'
193 * },
194 * {
195 * date: '20-Jun-2019 01:10',
196 * details: 'I have visited my Clan Citadel this week.',
197 * text: 'Visited my Clan Citadel.'
198 * },
199 * {
200 * date: '05-Jun-2019 04:34',
201 * details: 'I have visited my Clan Citadel this week.',
202 * text: 'Visited my Clan Citadel.'
203 * },
204 * {
205 * date: '07-Feb-2019 04:27',
206 * details: 'I have visited my Clan Citadel this week.',
207 * text: 'Visited my Clan Citadel.'
208 * },
209 * {
210 * date: '07-Feb-2019 04:24',
211 * details: 'I won a large amount of coins on Treasure Hunter!',
212 * text: 'Large amount of coins obtained.'
213 * },
214 * {
215 * date: '30-Jan-2019 05:40',
216 * details: 'I have visited my Clan Citadel this week.',
217 * text: 'Visited my Clan Citadel.'
218 * },
219 * {
220 * date: '03-Jan-2019 01:47',
221 * details: 'I have visited my Clan Citadel this week.',
222 * text: 'Visited my Clan Citadel.'
223 * },
224 * {
225 * date: '26-Dec-2018 10:22',
226 * details: 'I have visited my Clan Citadel this week.',
227 * text: 'Visited my Clan Citadel.'
228 * },
229 * {
230 * date: '04-Dec-2018 04:14',
231 * details: 'I have visited my Clan Citadel this week.',
232 * text: 'Visited my Clan Citadel.'
233 * },
234 * {
235 * date: '28-Nov-2018 05:31',
236 * details: 'I have visited my Clan Citadel this week.',
237 * text: 'Visited my Clan Citadel.'
238 * },
239 * {
240 * date: '08-Nov-2018 07:58',
241 * details: 'I levelled my Mining skill, I am now level 68.',
242 * text: 'Levelled up Mining.'
243 * },
244 * {
245 * date: '08-Nov-2018 07:43',
246 * details: 'I have visited my Clan Citadel this week.',
247 * text: 'Visited my Clan Citadel.'
248 * },
249 * {
250 * date: '14-Oct-2014 12:51',
251 * details: 'I levelled my Summoning skill, I am now level 62.',
252 * text: 'Levelled up Summoning.'
253 * },
254 * {
255 * date: '13-Oct-2014 00:30',
256 * details: 'I levelled my Hunter skill, I am now level 62.',
257 * text: 'Levelled up Hunter.'
258 * },
259 * {
260 * date: '13-Oct-2014 00:29',
261 * details: 'I levelled my Crafting skill, I am now level 69.',
262 * text: 'Levelled up Crafting.'
263 * },
264 * {
265 * date: '10-Aug-2014 01:50',
266 * details: 'I won a Lucky Armadyl crossbow on Treasure Hunter!',
267 * text: 'Lucky Armadyl crossbow obtained.'
268 * },
269 * {
270 * date: '02-May-2014 00:08',
271 * details: 'I levelled my Divination skill, I am now level 72.',
272 * text: 'Levelled up Divination.'
273 * }
274 * ],
275 * skillvalues: [
276 * { level: 99, xp: 150601597, rank: 87483, id: 8 },
277 * { level: 99, xp: 132964135, rank: 131197, id: 9 },
278 * { level: 99, xp: 131605606, rank: 174448, id: 11 },
279 * { level: 87, xp: 41775402, rank: 391262, id: 3 },
280 * { level: 87, xp: 39885284, rank: 362191, id: 2 },
281 * { level: 86, xp: 39335527, rank: 359811, id: 6 },
282 * { level: 85, xp: 35044619, rank: 344088, id: 1 },
283 * { level: 85, xp: 33169037, rank: 354179, id: 0 },
284 * { level: 83, xp: 27258878, rank: 274953, id: 10 },
285 * { level: 79, xp: 19172809, rank: 402003, id: 4 },
286 * { level: 76, xp: 13887225, rank: 332969, id: 5 },
287 * { level: 73, xp: 10224021, rank: 425629, id: 7 },
288 * { level: 72, xp: 9033714, rank: 286824, id: 25 },
289 * { level: 69, xp: 7178440, rank: 388167, id: 18 },
290 * { level: 69, xp: 7162753, rank: 405987, id: 12 },
291 * { level: 68, xp: 6155160, rank: 479803, id: 14 },
292 * { level: 65, xp: 4746375, rank: 482993, id: 13 },
293 * { level: 62, xp: 3569058, rank: 382899, id: 23 },
294 * { level: 62, xp: 3448319, rank: 378132, id: 21 },
295 * { level: 61, xp: 3272737, rank: 395359, id: 15 },
296 * { level: 61, xp: 3219611, rank: 400888, id: 24 },
297 * { level: 61, xp: 3138007, rank: 380394, id: 17 },
298 * { level: 60, xp: 2881919, rank: 393794, id: 20 },
299 * { level: 60, xp: 2831891, rank: 349363, id: 19 },
300 * { level: 60, xp: 2754656, rank: 431113, id: 16 },
301 * { level: 60, xp: 2744480, rank: 406241, id: 22 },
302 * { level: 1, xp: 0, rank: 0, id: 26 }
303 * ],
304 * name: 'Paqt',
305 * rank: '332,809',
306 * melee: 38605287,
307 * combatlevel: 116,
308 * loggedIn: 'false'
309 * }
310 */
311})
312```
313
314</details>
315
316## API