1.0.4 • Published 6 years ago

pubg-chicken v1.0.4

Weekly downloads
7
License
MIT
Repository
github
Last release
6 years ago

pubg-chicken npm 1.0.1

NodeJS Wrapper using the official PUBG API

Installation

$ npm install pubg-chicken@latest --save

Usage

let Chicken = require('pubg-chicken');
let api = new Chicken();
    api.setAPIkey('your-api-key-here');

API Wrappers

APIParameters
.setAPIkey().setAPIkey('your-api-key-here')
.searchPlayerNames().searchPlayerName({ playerNames: <ign> }, <region-here> ).then((apiResponse) => {})
.searchPlayerIds().searchPlayerIds({ playerIds: <acct-id> }, <region-here> ).then((apiResponse) => {})
.extractMatches().extractMatches({ playerNames: <player-ign> }, <region-here> ).then((matches) => {})
.searchTelemetry().searchTelemetry(<matchID-from-extractMatches()>, <region-here>).then((apiResponse) => {})

For example :

    // search player data using IGN name
    app.get('/name/:region/:playerName', function(req, res){
      
        api.searchPlayerNames({
            playerNames: req.params.playerName
            }, req.params.region).then((apiResponse) => { 
                // do something to apiResponse.
            });
      
    });

For example :

    // search player data using ID
    app.get('/name/:region/:playerID', function(req, res){
      
        api.searchPlayerIds({
            playerIds: req.params.playerID
            }, req.params.region).then((apiResponse) => { 
                // do something to apiResponse.
            });
      
    });

For example :

    // search player matches IDs using IGN name
    app.get('/matches/:region/:playerName', function(req, res){
      
        api.extractMatches({
            playerNames: req.params.playerName
            }, req.params.region).then((matches) => { 
                // do something to matches.
            });
      
    });

For example : (Note: To use .searchTelemetry(), you should have matchID results from .extractMatches() API)

    // search player matches IDs using IGN name
    app.get('/telemetry/:region/:matchID', function(req, res){
      
        api.searchTelemetry(req.params.matchID, req.params.region).then((apiResponse) => { 
                // do something to apiResponse.
            });
      
    });

Region parameters

Parameter region/platformLocation
xbox-asAsia
xbox-euEurope
xbox-naNorth America
xbox-ocOceania
pc-krjpKorea
pc-jpJapan
pc-naNorth America
pc-euEurope
pc-ocOceania
pc-kakaoKakao
pc-seaSouth East Asia
pc-saSouth and Central America
pc-asAsia

Status

v0.0.11 - API for searching IGN data only searchPlayerName

v0.0.17 - Added searching for player id searchPlayerIds, changed searchPlayerName to searchPlayerNames

v0.0.25 - Added searching for matches IDs extractMatches

v0.0.30 - Added searching for Telemetry for each matchesID searchTelemetry

v1.0.0 - Released

SEMVER - working on it to fully utilize PUBG API

  • Kevin Mocorro | kevinmocorro.github@gmail.com
1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago

0.0.31

6 years ago

0.0.30

6 years ago

0.0.29

6 years ago

0.0.28

6 years ago

0.0.27

6 years ago

0.0.26

6 years ago

0.0.25

6 years ago

0.0.24

6 years ago

0.0.23

6 years ago

0.0.22

6 years ago

0.0.21

6 years ago

0.0.20

6 years ago

0.0.19

6 years ago

0.0.18

6 years ago

0.0.17

6 years ago

0.0.16

6 years ago

0.0.15

6 years ago

0.0.14

6 years ago

0.0.13

6 years ago

0.0.12

6 years ago

0.0.11

6 years ago

0.0.10

6 years ago

0.0.9

6 years ago

0.0.8

6 years ago

0.0.7

6 years ago

0.0.6

6 years ago

0.0.5

6 years ago

0.0.4

6 years ago

0.0.3

6 years ago

0.0.2

6 years ago

0.0.1

6 years ago