players/dev.pubgkt.players

Package-level declarations

Types

PUBG Ban Type

data class Player(val id: String, val banType: BanType, val clanId: String?, val name: String, val titleId: String, val shardId: String, val patchVersion: String?, val matches: List<PlayerMatch>)

Player objects contain information about a player and a list of their recent matches (up to 14 days old). Note: player objects are specific to platform shards.

PlayerMatch

data class PlayerMatch(val id: String)

Functions

getPlayerByAccountId

suspend fun PubgApi.getPlayerByAccountId(accountId: String, platform: Platform = Platform.STEAM): Player

Returns a single player by their account ID.

getPlayersById

suspend fun PubgApi.getPlayersById(accountIds: List<String>, platform: Platform = Platform.STEAM): List<Player>

suspend fun PubgApi.getPlayersById(vararg accountIds: String, platform: Platform = Platform.STEAM): List<Player>

Returns players filtered by account IDs for the given platform.

getPlayersByNames

suspend fun PubgApi.getPlayersByNames(playerNames: List<String>, platform: Platform = Platform.STEAM): List<Player>

suspend fun PubgApi.getPlayersByNames(vararg playerNames: String, platform: Platform = Platform.STEAM): List<Player>

Returns players filtered by in-game names for the given platform.