thesportsdb-client/io.github.rohang27.thesportsdb.model/League

League

class League : ApiRecord

A league or cup. Lists (all_leagues.php, v2 search/league) fill only a few fields; look it up by id for the rest.

Properties

alternateNames

val alternateNames: List<String>

strLeagueAlternate, split on commas

apiFootballId

val apiFootballId: Long?

idAPIfootball

apiFootballV3Id

val apiFootballV3Id: Long?

idAPIfootballv3

badge

val badge: String?

strBadge

banner

val banner: String?

strBanner

country

val country: String?

strCountry

currentSeason

val currentSeason: String?

strCurrentSeason, e.g. 2026-2027 or 2026. Pass it to season endpoints.

description

val description: String?

The English description, if any.

descriptions

val descriptions: Map<String, String>

strDescriptionEN, strDescriptionDE, ... keyed by language code (EN, DE)

division

val division: Int?

intDivision: 1 for a top flight; cups often use 0 or 99

eventNaming

val eventNaming: String?

strNaming: the event-name template, e.g. {strHomeTeam} vs {strAwayTeam}

fanart

val fanart: List<String>

strFanart1..strFanart4

firstEventDate

val firstEventDate: LocalDate?

dateFirstEvent

formedYear

val formedYear: Int?

intFormedYear

gender

val gender: String?

strGender

val id: Long?

idLeague

isComplete

val isComplete: Boolean?

strComplete: whether TheSportsDB considers its data complete

isCup

val isCup: Boolean?

idCup: true for a cup competition

isLocked

val isLocked: Boolean?

strLocked

logo

val logo: String?

strLogo

name

val name: String?

strLeague

poster

val poster: String?

strPoster

raw

val raw: RawRecord

Every field as the API sent it. Use it for fields not modelled yet: team.raw["strKeywords"].

socials

val socials: Socials

sport

val sport: String?

strSport

trophy

val trophy: String?

strTrophy

tvRights

val tvRights: String?

strTvRights: free text

Functions

equals

operator override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int

toString

open override fun toString(): String