@zaytt/pubg

A powerful and light PlayerUnknown's Battlegrounds stats API wrapper,
for Node.js and for the web.

pubg.js docs | api docs | changelog | issues

pubg.js makes it easy to interact with the pubg dev api. Written with an intelligent and performant api, making it easy for anyone to access a massive database of pubg data, including players stats, matches, teams, events of matches and much more. Built with customizable caching, for maximum performance, and quicker data retrieval. Includes full documentation and IDE auto completion support.

Setup and Installation

1. Signup at the pubg dev api site
2. Register an app, giving you a key
3. Install pubg.js npm install pubg.js --save
4. When using the wrapper, parse your generated key when creating the client

Examples

// Require model and initiate client with api key
const pubg = require('pubg.js');
const client = new pubg.Client('yourKey', 'region');

// Get a single player using their name
const player = client.getPlayer({name: 'yeye155'})
    .then(player => /* Use an extensive class of data */)
    .catch(error => /* Catch any errors */)

// Retrieve thousands of recent matches, and get stats for any of them
const player = client.getSamples()
    .then(matches => /* Have access to the PUBG's extensive list of matches */)
    .catch(error => /* Catch any errors */)

// Fetch a match with a heap of data on every participant of the match and their stats
const player = client.getSamples()
    .then(match => {
        // Manipulate the data in any way you like, or even get match telemetry data 
        match.fetchTelemetry()
        // View a heap of data on the teams - best k/d, winning team etc
        match.relationships.rosters

    })
    .catch(error => /* Catch any errors */)

Web

In addition to the Node.js environment, pubg.js also fully supports the web. Useful for interacting with the pubg api with static pages or without the use of a backend. All up, the minified version comes down to as little as 17KB. You can find the latest version in the webpack branch. To use it, choose one of the following options and pubg will be defined in the window scope. It's as simple as the example above but without the need to require the package first.

• Download it: normal, minified
• Production: normal, minified
• Development: normal, minified

Issues

If you run into any issues, have any queries or concerns or would just like to make a few suggestions please do not hesitate to join our discord support server