Skip to content

Latest commit

 

History

History
158 lines (120 loc) · 2.54 KB

README.md

File metadata and controls

158 lines (120 loc) · 2.54 KB

skyblock.js

A library for the skyblock.net api

Features

  • List online players on Economy, Survival and Skywars.
  • Get friends of a player from their forums ID.
  • Search for forum accounts by query.
  • Get information about a player by their IGN.
  • Get friends of a player by their IGN.

Installation

npm i skyblock.js

See below for usage.

Usage

Current Economy info

const sb = require("skyblock.js")
sb.economy().then(data => {
    console.log(data);
})

Current Survival info

const sb = require("skyblock.js")
sb.survival().then(data => {
    console.log(data);
})

Current Skywars info

const sb = require("skyblock.js")
sb.skywars().then(data => {
    console.log(data);
})

Forums username search

const sb = require("skyblock.js")
sb.forumsSearch("<QUERY>").then(data => {
    console.log(data);
})

Player info

const sb = require("skyblock.js")
sb.player("<IGN>").then(data => {
    console.log(data);
})

Friends by IGN

const sb = require("skyblock.js")
sb.friendsByIGN("<IGN>").then(data => {
    console.log(data);
})

Friends by forums ID

const sb = require("skyblock.js")
sb.friendsByForumsID("<FORUMS ID>").then(data => {
    console.log(data);
})

Get current amount of players on a Noobcrew server

A list of possible values can be found here

const sb = require("skyblock.js")
sb.playerCount("<SERVER NAME>").then(data => {
    console.log(data);
})

Friends by UUID

const sb = require("skyblock.js")
sb.friendsByUUID("<UUID>").then(data => {
    console.log(data);
})

Skyblock download stats

const sb = require("skyblock.js")
sb.getDownloadStats().then(data => {
    console.log(data);
})

Staff list

const sb = require("skyblock.js")
sb.getStaff().then(data => {
    console.log(data);
})

Get User by UUID

const sb = require("skyblock.js")
sb.playerByUUID("<UUID>").then(data => {
    console.log(data);
})

Get User forums Info

const sb = require("skyblock.js")
sb.forumsUserInfo("<ID>").then(data => {
    console.log(data);
})

Get Current Trader Info

const sb = require("skyblock.js")
sb.getTraders("<server>").then(data => {
    console.log(data);
})

Convert UUID to IGN

const sb = require("skyblock.js")
sb.UUIDToName("<UUID>").then(data => {
    console.log(data);
})