PUBG Royale

This is a PUBG API wrapper for Node.js with built-in caching that originated from the statg discord bot. There might be better wrappers out there, but feel free to use this one if you like ;)

Features

• Get infos and statistics about players, matches, seasons, tournaments, api status.
• All api calls are asynchronious with promises.
• Results are cached. Cache timings can be configured.
• API results are automatically parsed to Javascript objects.
• API errors are converted to native Javascript errors for easier error handling.
• Works for PC regions "steam" and "kakao".

The composition of the objects returned by pubg-royle match the JSON returned by the PUBG API. So be sure to read the relevant parts of the official docs.

Install

npm install pubg-royale

Also make sure to grab a key for the PUBG API here. IMPORTANT: Keep your key secret!

Use

const pubgRoyale = require('pubg-royale');
 
const client = new pubgRoyale.Client({
  // Put your api key here
  key: 'YOUR_KEY_HERE',
 
  // Default region used for api calls. Defaults to "steam" if omitted.
  // The region can be set for individual api calls.
  defaultRegion: pubgRoyale.REGIONS.PC.STEAM,
 
  // Specifies ttl in ms for cached objects. Any value ommited defaults to 60 seconds.
  // Set every value to zero to disable caching
  cache: { 
    player: 10 * 1000,
    playerStats: 10 * 1000,
    match: 10 * 1000,
    status: 10 * 1000,
    seasons: 10 * 1000,
  },
});
 
client.player({ name: 'JohnDoe' })
  .then((player) => {
    // do something with the player
  })
  .catch((error) => {
    // handle error
  });

Changelog

1.1.0

• Support for pubg api v6.0.0 style seasons stats url format (fixes #4)

2.0.0

• Support for new grouped PC regions "steam" and "kakao". Support for console regions dropped for now.

2.1.0

• added lifetimeStats() which can be used to fetch lifetime stats of a player

2.1.1

• Security updates

License

MIT