pubgkt – common

Core module providing the PubgApi client, platform enums, seasons, rate limiting, and retry configuration.

API Reference | PUBG Official Docs

Installation

Gradle Kotlin DSL

dependencies {
    implementation("dev.pubgkt:common:1.0.1")
}

Gradle Groovy

dependencies {
    implementation 'dev.pubgkt:common:1.0.1'
}

Maven

<dependency>
    <groupId>dev.pubgkt</groupId>
    <artifactId>common-jvm</artifactId>
    <version>1.0.1</version>
</dependency>

API Reference

| Function | Description | |----------|-------------| | PubgApi.isUp() | Check if the PUBG API is up and healthy | | PubgApi.seasons(platform) | Get available seasons by platform | | PubgApi.seasons(platformRegion) | Get available seasons by platform region | | List<Season>.currentOrNull() | Find the current season from a list |

Usage

Kotlin

val api = PubgApi(apiKey = "your-api-key")

// Check API status
val isUp = api.isUp()

// Get seasons
val seasons = api.seasons(Platform.STEAM)
val current = seasons.currentOrNull()

Java

PubgApi api = new PubgApi("your-api-key");

Boolean isUp = BuildersKt.runBlocking(
        EmptyCoroutineContext.INSTANCE,
        (_, cont) -> StatusKt.isUp(api, cont)
);

List<Season> seasons = BuildersKt.runBlocking(
        EmptyCoroutineContext.INSTANCE,
        (_, cont) -> SeasonKt.seasons(api, Platform.STEAM, cont)
);

Configuration

Rate Limiting

// Default — automatically delays when rate limit is about to be hit
val api = PubgApi("your-api-key")

// No rate limiting
val api = PubgApi("your-api-key", rateLimiter = RateLimiter.None)

// Concurrent rate limiter (thread-safe)
val api = PubgApi("your-api-key", rateLimiter = ConcurrentDelayRateLimiter())

Retry Policy

// No retry (default)
val api = PubgApi("your-api-key", retry = NoRetry)

// Retry with exponential backoff
val api = PubgApi(
    "your-api-key",
    retry = Retry(
        maxRetries = 5,
        backoff = ExponentialBackoff(
            base = 2.0,
            baseDelayMs = 1_000,
            maxDelayMs = 60_000,
        ),
    ),
)