samiaraboglu/pubg-php-api

v2.0.0 2021-01-22 23:34 UTC

Requires

• php: ^7.3
• ext-json: *
• guzzlehttp/guzzle: ^6.3

MIT

• Sami Araboğlu

• php
• pubg
• pubg-php
• pubg-api

README

PlayerUnknown's Battlegrounds Php Api

• PUBG Official Documentation

Installing

Via composer

$ composer require samiaraboglu/pubg-php-api

Config

$config = new Pubg\Config();
$config->setApiKey('{API_KEY}');
$config->setPlatform('{PLATFORM}');

$api = new Pubg\Api($config);

Platform: kakao, psn, steam, tournament, xbox

Platform Region: pc-as, pc-eu, pc-jp, pc-kakao, pc-krjp, pc-na, pc-oc, pc-ru, pc-sa, pc-sea, pc-tournament, psn-as, psn-eu, psn-na, psn-oc, xbox-as, xbox-eu, xbox-na, xbox-oc, xbox-sa

Players

Use the player service.

$playerService = new Pubg\Player($api);

Get a single player by name or accound ID.

// by player name
$player = $playerService->get('{PLAYER_NAME}');

// by account id
$player = $playerService->get('{ACCOUNT_ID}');

Get a collection of up to 6 players by names or account IDs.

// by players names
$players = $playerService->getAll(['{PLAYER_NAME_1}', '{PLAYER_NAME_2}']);

// by accounts ids
$players = $playerService->getAll(['{ACCOUNT_ID_1}', '{ACCOUNT_ID_2}']);

Season Stats

Use the season service.

$seasonService = new Pubg\Season($api);

Get the list of available seasons.

$seasons = $seasonService->getAll();

Get season information for a single player.

$season = $seasonService->get('{ACCOUNT_ID}', '{SEASON_ID}');

Lifetime Stats

Use the lifetime service.

$lifetimeService = new Pubg\Lifetime($api);

Get lifetime stats for a single player.

$lifetime = $lifetimeService->get('{ACCOUNT_ID}');

Matches

Use the match service.

$matchService = new Pubg\Match($api);

Get a single match.

$match = $matchService->get('{MATCH_ID}');

Leaderboards

Use the leaderboard service.

$leaderboardService = new Pubg\Leaderboard($api);

Get the leaderboard for a game mode.

$leaderboards = $leaderboardService->get('{GAME_MODE}', {PAGE_NUMBER});

Game modes: duo, duo-fpp, solo, solo-fpp, squad, squad-fpp

Page numbers: 0, 1

Tournaments

Use the tournament service.

$tournamentService = new Pubg\Tournament($api);

Get the list of available tournaments.

$tournaments = $tournamentService->getAll();

Get information for a single tournament.

$tournament = $tournamentService->get('{TOURNAMENT_ID}');

Samples

Use the samples service.

$sampleService = new Pubg\Sample($api);

Get a list of sample matches.

$samples = $sampleService->get();

// date filter
$samples = $sampleService->get('2019-03-29T00:00:00Z');