thesportsdb-client/io.github.rohang27.thesportsdb/SportsDbConfig

SportsDbConfig

Client settings. Build with SportsDbClient's DSL:

val client = SportsDbClient { apiKey = System.getenv("THESPORTSDB_API_KEY") }

Constructors

SportsDbConfig

constructor()

Types

Companion

object Companion

Properties

apiKey

var apiKey: String

Your API key. Defaults to the public free key 123 (v1 only, small result limits).

baseUrl

var baseUrl: String

Change only for testing or a proxy.

cache

var cache: ResponseCache?

Optional response cache; null (the default) disables caching.

cachePolicy

var cachePolicy: CachePolicy

Time-to-live per kind of data, used when cache is set.

deduplicateRequests

var deduplicateRequests: Boolean

Share one HTTP request between identical calls made at the same time (same URL and key), so ten coroutines asking for the same table cause one request, not ten.

isFreeKey

val isFreeKey: Boolean

True when apiKey is one of the public free keys (FREE_API_KEYS). Any other key the API accepts is a paid key; see SportsDbClient.isPremiumKey to check one.

maxRetries

var maxRetries: Int

Retries for network errors and HTTP 5xx, with exponential backoff.

rateLimitWait

var rateLimitWait: Duration

How long to wait after a 429 when the server does not say. The docs say one minute.

requestListener

var requestListener: RequestListener?

Called once per call, after it finishes: for logging and metrics. See RequestEvent.

requestsPerMinute

var requestsPerMinute: Int?

Client-side limit, in requests per minute, shared by v1 and v2. null picks the documented limit for the key: 30 for the free key, 100 for a premium key. Set it to 120 on a business plan, or 0 to turn limiting off.

retryBackoff

var retryBackoff: Duration

First backoff delay; doubles on every retry.

retryOnRateLimit

var retryOnRateLimit: Boolean

On HTTP 429, wait (the Retry-After time, or rateLimitWait) and try once more.

timeout

var timeout: Duration

Time allowed for one HTTP request (connect, send and read). Applies to the default transport.

transport

var transport: HttpTransport?

The HTTP stack. null (the default) uses OkHttp with timeout. Pass OkHttpTransport(yourClient) to share an OkHttp client (its own timeouts then apply).

userAgent

var userAgent: String

Functions

setRateLimitWait

fun setRateLimitWait(value: Duration)

Java: sets rateLimitWait.

setRetryBackoff

fun setRetryBackoff(value: Duration)

Java: sets retryBackoff.

setTimeout

fun setTimeout(value: Duration)

Java: sets timeout.