A NodeJS wrapper for the Among Stats API. The documentation of the API endpoints: API Documentation
Installing:
npm install amongstats
Require module using
constamongstats=require("amongstats");Module exports:
letuser=newamongstats.UserClient();Returns a new user client that can be used to login and access user data.
letguild=newamongstats.GuildClient();Returns a new guild client that can be used to login and access guild data.
user.login(userToken);Will attempt to "login" by checking the validity of the given token, and if it is valid, it will remember the token for other requests. Token generated using the Discord bot command ;generatetoken.
guild.login(guildToken);Will attempt to "login" by checking the validity of the given token, and if it is valid, it will remember the token for other requests. Token generated using the Discord bot command ;generateguildtoken.
amongstats.setApplicationCode(applicationCode);Sets the application code for uploading statistics. This is optiona, but it is recommended to set the application code at the start of your application. It will track which application uploaded the statistics, and statistics will be visible on the Developer Tools.
UserClient methods (each returns a promise):
// Returns basic information on the Discord user like username, avatar code and when the AmongStats account was createduser.getInfo()// Adds statistics to the users account. stats has to be an array of 18 integersuser.addStats(stats)// Returns the most recent statistics of the useruser.getStats()// Returns all of the users uploaded statisticsuser.getStatsHistory()GuildClient methods (each returns a promise):
// Returns basic information on the Discord guild like id, name, icon code, command_prefix, owner, joined_on, screenshot_channelletinfo=awaitguild.getInfo()// Returns a list of all the users in the guild with an account, along with their hidden statusletusers=awaitguild.getUsers()// Returns basic information on a single userletuser=awaitguild.getUser(userId)// Returns the most recently uploaded statistics from the given userletuserStats=awaitguild.getUserStats(userId)// Returns all uploaded statistics from the given userletuserStatsHistory=awaitguild.getUserStatsHistory(userId)// Returns the most recently uploaded statistics from all users in the guild with an accountletstats=awaitguild.getStats()