/pubg.op.gg-API-Wrapper

Primary LanguageJavaScript

npm version License: MIT

pubg.op.gg

Playerunknown's Battlegrounds API Wrapper with Redis caching. I've used This Module as reference and appended it for the usage of the API from PUBG.OP.GG

  • The API is maintained and provided by https://pubg.op.gg and all credits go to them. Thank you for providing all the data needed.

  • It caches all http requests for 5 minutes in Redis.

Installation

npm install -S pubg-op-gg

Usage

The API for PUBG.OP.GG doesn't require any API key. However you'll need to provide the user id (Steam ID). The results are very limited, as the origin does not provide a lot of stats, as there is no documentation, everything provided in this wrapper is what I do know so far.

const {PubgAPI, PubgAPIErrors, REGION, SEASON, MATCH} = require('pubg.op.gg');

// If no Redis configuration it wont be cached
const api = new PubgAPI({
  redisConfig: {
    host: '127.0.0.1',
    port: 6379,
    expiration: 300, // Optional - defaults to 300.
  },
});

api.getProfileByID('59fdabfb33bd730001661ad2', SEASON.RE2018sea1, REGION.EU, MATCH.SQUAD.size, MATCH.SQUAD.name)
  .then((profile) => {
    const data = profile.getStats();
    console.log(data);
  })
  .catch((err) => {
  	console.error(err);
  });

api.getProfileByNickname('kvn1351', SEASON.RE2018sea1, REGION.EU, MATCH.SQUAD.size, MATCH.SQUAD.name)
  .then((profile) => {
    const data = profile.getStats();
    console.log(data);
  })
  .catch((err) => {
  	console.error(err);
  });

The methods currently available are: getRank() getMaxRank() getStats()