1.0.0 • Published 2 years ago

roblox-fetch v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

RobloxJS

Roblox API written as a nodejs module. (sorry if any of this is wrong, i had a panic attack half way through lol)

How to install

Since my NPMJS account is currently down, you can only install using this command:

npm i https://github.com/DwifteJB/RobloxJS

This requires GIT to be installed.

How to use

Place Class

Get Details of Place

API Documentation

const robloxjs = require("robloxjs")
(async () => {
    let Place = await new robloxjs.Place(2506738224) // Place ID
    let placeDetails = await Place.getDetails()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Get Settings of Place

API Documentation

const robloxjs = require("robloxjs")
(async () => {
    let Place = await new robloxjs.Place(2506738224) // Place ID
    let PlaceSettings = await Place.getSettings()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Get Universe ID of Place

API Documentation

const robloxjs = require("robloxjs")
(async () => {
    let Place = await new robloxjs.Place(2506738224) // Place ID
    let UniverseJSON = await Place.getUniverse()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Get Game Instances

API Documentation

const robloxjs = require("robloxjs")
(async () => {
    let Place = await new robloxjs.Place(2506738224) // Place ID
    let gameInstances = await Place.getGameInstances()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Player Class

Get Avatar Icons

API DOCUMENTATION

 const robloxjs = require("robloxjs")
(async () => {
    let Player = await new robloxjs.Player(1) // Player ID
    let onlineStatus = await Player.getAvatar()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!

const robloxjs = require("robloxjs")
(async () => {
    let Player = await new robloxjs.Player(1) // Player ID
    let onlineStatus = await Player.getAvatarBust()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!

    const robloxjs = require("robloxjs")
(async () => {
    let Player = await new robloxjs.Player(1) // Player ID
    let onlineStatus = await Player.getAvatarHeadshot()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!

Get Online Status

API DOCUMENTATION

const robloxjs = require("robloxjs")
(async () => {
    let Player = await new robloxjs.Player(1) // Player ID
    let onlineStatus = await Player.getOnlineStatus()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Get Player's Created Games

API DOCUMENTATION

const robloxjs = require("robloxjs")
(async () => {
    let Player = await new robloxjs.Player(1) // Player ID
    let createdGames = await Player.getCreatedGames()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Get Player's General Info

API DOCUMENTATION

const robloxjs = require("robloxjs")
(async () => {
    let Player = await new robloxjs.Player(1) // Player ID
    let generalInfo = await Player.getInfo()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Get Player's older Usernames

API DOCUMENTATION

const robloxjs = require("robloxjs")
(async () => {
    let Player = await new robloxjs.Player(1) // Player ID
    let olderUsernames = await Player.getOldUsernames()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Universe Class

How do I get a universe ID?

Well, simply use the Get Universe ID of Place section from the Player Class

Get all places connected to Universe

API DOCUMENTATION

const robloxjs = require("robloxjs")
(async () => {
    let Universe = await new robloxjs.Universe(1337) // Universe ID
    let UniversePlaces = await Universe.getPlaces()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Get Info

API DOCUMENTATION

const robloxjs = require("robloxjs")
(async () => {
    let Universe = await new robloxjs.Universe(1337) // Universe ID
    let UniverseInfo = await Universe.getInfo()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Get Price of Game

API DOCUMENTATION

const robloxjs = require("robloxjs")
(async () => {
    let Universe = await new robloxjs.Universe(1337) // Universe ID
    let UniversePrices = await Universe.getPrice()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Other Methods

Get IDs from Usernames

API DOCUMENTATION

const robloxjs = require("robloxjs")
(async () => {
    let IDS = await robloxjs.getPlayerIDFromUsernames(["RobsPlayz", "Roblox"], false) // IDS IN ARRAY, EXCLUDE BANNED MEMBERS?
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!

Note

There is a "user" class that is currently unused in the index.js file, this is due to it not working and it is being looked on. If anyone could help our team look for a way to use it, that would be appreciated.

Special Thanks

Special thanks to roblox-api & roblox-web-apis for the documentation on the API

1.0.0

2 years ago