Home

PUBG TypeScript API wrapper

Basics

The basic idea behind this module is to make it easy to work on PUBG API by providing an abstraction layer over the official API, so you can worry about relationships between entities instead of the underlying details of the data structure returned from the API.

Entities

An "Entity" is a class that roughly corresponds to an API resource, like a Player, Match or Roster. However, as you will see, entities have some helpful utilities that make it easier to work with the API.
The main entities and entry point to all other entities are Player and Match.

The structure is this:

• Player
  • misc player fields (ID, name, ...)
  • string[] list of recent battle IDs
• Match
  • misc match fields (ID, date, map, ...)
  • Asset
    • URL of telemetry file for this match
  • List of Participant
    • player data and statistics in the context of this match
  • List of Roster
    • misc team stats in the context of this match
    • List of Participant: list of participant objects inside this team