@dwifte/robloxjs
v1.2.1
Published
Roblox API Wrapper written in NodeJS using fetch.
Downloads
3
Readme
RobloxJS
Roblox API written as a nodejs module.
How to install
npm i https://github.com/DwifteJB/RobloxJS
How to use
Requiring
const robloxjs = require("@dwifte/robloxjs")
Place Class
Get Details of Place
API Documentation
(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
(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
(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
(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
(async () => {
let Player = await new robloxjs.Player(1) // Player ID
let onlineStatus = await Player.getAvatar()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!
(async () => {
let Player = await new robloxjs.Player(1) // Player ID
let onlineStatus = await Player.getAvatarBust()
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!
(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
(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
(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
(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
(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
(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
(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
(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
(async () => {
let IDS = await robloxjs.getPlayerIDFromUsernames(["RobsPlayz", "Roblox"], false) // IDS IN ARRAY, EXCLUDE BANNED MEMBERS?
})(); // EVERYTHING MUST BE DONE IN AN ASYNC ENVIRONMENT!!
Special Thanks
Special thanks to roblox-api & roblox-web-apis for the documentation on the API