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
- Signup at the pubg dev api site
- Register an app, giving you a key
- Install pubg.js
npm install pubg.js --save
- When using the wrapper, parse your generated key when creating the client
Examples
// Require model and initiate client with api keyconst pubg = ;const client = 'yourKey' 'region'; // Get a single player using their nameconst player = client // Retrieve thousands of recent matches, and get stats for any of themconst player = client // Fetch a match with a heap of data on every participant of the match and their statsconst player = client
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.
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