{"id":19001608,"url":"https://github.com/kevcodez/pubg-api-kotlin","last_synced_at":"2025-10-04T07:42:22.358Z","repository":{"id":57730659,"uuid":"125750872","full_name":"kevcodez/pubg-api-kotlin","owner":"kevcodez","description":"Kotlin wrapper for the Playerunknowns Battlegrounds Developer API, Java 8+","archived":false,"fork":false,"pushed_at":"2019-01-25T10:24:13.000Z","size":5141,"stargazers_count":10,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-22T17:58:58.806Z","etag":null,"topics":["api","kotlin","playerunknowns-battlegrounds","pubg","wrapper"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kevcodez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-18T17:38:26.000Z","updated_at":"2024-05-19T15:35:58.000Z","dependencies_parsed_at":"2022-09-26T22:01:33.556Z","dependency_job_id":null,"html_url":"https://github.com/kevcodez/pubg-api-kotlin","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/kevcodez/pubg-api-kotlin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevcodez%2Fpubg-api-kotlin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevcodez%2Fpubg-api-kotlin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevcodez%2Fpubg-api-kotlin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevcodez%2Fpubg-api-kotlin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevcodez","download_url":"https://codeload.github.com/kevcodez/pubg-api-kotlin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevcodez%2Fpubg-api-kotlin/sbom","scorecard":{"id":556711,"data":{"date":"2025-08-11","repo":{"name":"github.com/kevcodez/pubg-api-kotlin","commit":"f3b08360ac7303f7223974bc262c3fd3ad094f7d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-20T12:34:09.901Z","repository_id":57730659,"created_at":"2025-08-20T12:34:09.901Z","updated_at":"2025-08-20T12:34:09.901Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278283492,"owners_count":25961310,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","kotlin","playerunknowns-battlegrounds","pubg","wrapper"],"created_at":"2024-11-08T18:12:05.516Z","updated_at":"2025-10-04T07:42:22.341Z","avatar_url":"https://github.com/kevcodez.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"PUBG API wrapper written in Kotlin. Requires Java 1.8+. \n\n[Official API Page](https://developer.playbattlegrounds.com)\n\n![Maven metadata URI](https://img.shields.io/maven-metadata/v/http/central.maven.org/maven2/de/kevcodez/pubg/pubg-api-wrapper/maven-metadata.xml.svg)\n [![Build Status](https://travis-ci.org/kevcodez/pubg-api-kotlin.svg?branch=master)](https://travis-ci.org/kevcodez/pubg-api-kotlin)\n[![GitHub license](https://img.shields.io/github/license/kevcodez/pubg-api-kotlin.svg)](https://github.com/kevcodez/pubg-api-kotlin/blob/master/LICENSE)\n\n# Table of Contents\n\n- [Getting started](#getting-started)\n  * [Maven](#maven)\n  * [Gradle](#gradle)\n  * [API Key](#api-key)\n- [Usage](#usage)\n  * [First request](#first-request)\n  * [Players](#players)\n    + [Searching for players by id/name](#searching-for-players-by-id-name)\n    + [Searching for player by ID](#searching-for-player-by-id)\n  * [Matches](#matches)\n    + [Searching for match by ID](#searching-for-match-by-id)\n  * [Tournaments](#tournaments)\n    + [Get all tournmanets](#get-all-tournmanets)\n    + [Get tournament by ID](#get-tournament-by-id)\n  * [Seasons](#seasons)\n    + [Get seasons](#get-seasons)  \n    + [Get player season](#get-player-season)  \n  * [Status](#status)\n  * [Telemetry data](#telemetry-data)\n- [Implementation](#implementation)\n- [Links](#links)\n\n# Getting started\n\nThe releases are pushed to maven central. Include the latest release in your build file.\n\n## Maven\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ede.kevcodez.pubg\u003c/groupId\u003e\n    \u003cartifactId\u003epubg-api-wrapper\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Gradle\n\n```groovy\ncompile \"de.kevcodez.pubg:pubg-api-wrapper:1.0.0\"\n```\n\n## API Key\n\nIf you do not have an API key yet, go to the [Official API Page](https://developer.playbattlegrounds.com) and register.\n\n# Usage\n\n## First request\n\n```kotlin\nval apiClient = ApiClient(\"my-key\", OkHttpClient())\n\nval match = apiClient.getMatch(Platform.STEAM, \"id\")\nprintln(match.duration)\n```\n\nYou can configure the [OkHttp3 Client](http://square.github.io/okhttp/) to register proxies or interceptors.\n\n## Players\n\nYou can search for players by their ID/name or get information about a specific player.\n\n### Searching for players by id/name\n\n```kotlin\nval playerResponse = apiClient.getPlayers(Platform.STEAM, PlayerFilter(playerNames = listOf(\"shroud\")))\nplayerResponse.players.forEach { \n    println(it.id)\n}\n```\n\n### Searching for player by ID\n\n```kotlin\nval playerResponse = apiClient.getPlayer(Platform.STEAM, \"\u003cid\u003e\")\nplayerResponse.players.forEach { \n    println(it.id)\n}\n```\n\n## Matches\n\nYou can only search for concrete matches by ID.\n\n### Searching for match by ID\n\n```kotlin\nval apiClient = ApiClient(\"my-key\", OkHttpClient())\n\nval match = apiClient.getMatch(Platform.STEAM, \"id\")\nprintln(match.duration)\n```\n\n## Tournaments\n\n### Get all tournmanets\n\n```kotlin\nval apiClient = ApiClient(\"my-key\", OkHttpClient())\nval tournaments = apiClient.getTournaments()\n```\n\n### Get tournament by ID\n\n```kotlin\nval apiClient = ApiClient(\"my-key\", OkHttpClient())\nval tournament = apiClient.getTournament(\"\u003cid\u003e\")\n```\n\n## Seasons\n\n### Get seasons\n\n```kotlin\nval apiClient = ApiClient(\"my-key\", OkHttpClient())\nval seasons = apiClient.getSeasons(Platform.STEAM)\n```\n\n### Get player season\n\n```kotlin\nval apiClient = ApiClient(\"my-key\", OkHttpClient())\nval season = apiClient.getSeason(Platform.STEAM, \"account-id\", \"seasonId\")\n```\n\n## Status\n\n```kotlin\nval status = apiClient.isStatusOk()\nprintln(status) // bool\n```\n\n## Telemetry data\n\nCheck the de.kevcodez.pubg.model.telemetry package for all structures. The telemetry data contains a list of telemetry events.\n\n```kotlin\nval telemetryData = apiClient.getTelemetryData(\"url\")\n\ntelemetryData.filter { it is PlayerKill }.map { it as PlayerKill }.forEach {\n    println(\"Kill at ${it.timestamp}\")\n    println(\"Killer: ${it.killer}\")\n    println(\"Victim: ${it.victim}\")\n}\n```\n\nPrints\n\n\u003e Kill at 2018-04-15T15:13:08.912Z\n\u003e  Killer: Character(name=sen10za, teamId=44, health=100.0, location=Location(x=415623.0, y=465934.06, z=3607.5898), ranking=0, accountId=account.116f300334ef4310bdbe2e5e51253663)\n\u003e  Victim: Character(name=sen10za, teamId=44, health=100.0, location=Location(x=415623.0, y=465934.06, z=3607.5898), ranking=0, accountId=account.116f300334ef4310bdbe2e5e51253663)\n\u003e  Kill at 2018-04-15T15:13:55.544Z\n\u003e  Killer: Character(name=Muzhik_Raketa, teamId=15, health=100.0, location=Location(x=408639.56, y=456094.12, z=4953.4897), ranking=0, accountId=account.6083879a56a1403c964af920e2b6534e)\n\u003e  Victim: Character(name=Muzhik_Raketa, teamId=15, health=100.0, location=Location(x=408639.56, y=456094.12, z=4953.4897), ranking=0, accountId=account.6083879a56a1403c964af920e2b6534e)\n\u003e  Kill at 2018-04-15T15:14:53.828Z\n\u003e  Killer: Character(name=kavek, teamId=15, health=90.0, location=Location(x=408673.34, y=457988.9, z=4938.0), ranking=0, accountId=account.00044da12eda458d9d493ae7f7cf87db)\n\u003e  Victim: Character(name=kavek, teamId=15, health=90.0, location=Location(x=408673.34, y=457988.9, z=4938.0), ranking=0, accountId=account.00044da12eda458d9d493ae7f7cf87db)\n\n\n# Implementation\n\nThe [OkHttp3](http://square.github.io/okhttp/) client is used as HTTP client. During the creation of the API client, you can register your own OkHttpClient and register interceptors, proxies, etc.\n\nFor parsing the JSON responses, [Jackson FasterXML](https://github.com/FasterXML/jackson) is used.\n\n# Links\n\n[Official Documentation](https://developer.playbattlegrounds.com)\n\n[Official assets, like images, and dictionaries](https://github.com/pubg/api-assets).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevcodez%2Fpubg-api-kotlin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevcodez%2Fpubg-api-kotlin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevcodez%2Fpubg-api-kotlin/lists"}