kickerde_api_client.model.league

Upstream model for leagues, tournaments, and seasons.

Attributes

`ConferenceId`	Upstream ID with unknown semantics.
`DivisionId`	Upstream ID with unknown semantics.
`GamedayId`	Upstream ID for a match day within a league or tournament.
`GroupId`	Upstream ID with unknown semantics.
`LeagueTableId`	Upstream ID for a (partial or complete) league table.
`SeasonId`	Upstream ID for a season of a league or tournament.

Classes

`TableCalculatorType`	Upstream ID to identify the type of table calculator to be
`League`	Upstream model for a league or tournament.
`Season`	Upstream model for the season of a league or tournament.
`Gameday`	Upstream model for a match day.
`LeagueSeason`	Upstream model for a hierarchical view on a league in a season.
`LeagueTableEntry`	Upstream model for an entry in a league table.
`LeagueTable`	Upstream model for a league table.

Module Contents

kickerde_api_client.model.league.ConferenceId: TypeAlias = int: Upstream ID with unknown semantics.

kickerde_api_client.model.league.DivisionId: TypeAlias = int: Upstream ID with unknown semantics.

kickerde_api_client.model.league.GamedayId: TypeAlias = int: Upstream ID for a match day within a league or tournament.

kickerde_api_client.model.league.GroupId: TypeAlias = int: Upstream ID with unknown semantics.

kickerde_api_client.model.league.LeagueTableId: TypeAlias = int: Upstream ID for a (partial or complete) league table.

kickerde_api_client.model.league.SeasonId: TypeAlias = str: Upstream ID for a season of a league or tournament.

class kickerde_api_client.model.league.TableCalculatorType

Bases: enum.IntEnum

Upstream ID to identify the type of table calculator to be used for a given league.

LEAGUE = 1: League-style table calculation

TOURNAMENT = 2: Tournament-style table calculation

class kickerde_api_client.model.league.League

Bases: TypedDict

Upstream model for a league or tournament.

id: kickerde_api_client.model.league_id.LeagueId

shortName: str

longName: str

currentSeasonId: SeasonId

currentRoundId: int

currentRoundName: NotRequired[str]

iconSmall: NotRequired[str]

iconBig: NotRequired[str]

displayKey: int

displayKey2: int

table: NotRequired[int]

stateId: NotRequired[kickerde_api_client.model.core.StateId]

countryId: kickerde_api_client.model.core.CountryId

associationId: NotRequired[kickerde_api_client.model.association.Association]

sportId: kickerde_api_client.model.core.SportId

teamOrigin: NotRequired[bool]

imId: int

urlName: str

uShortName: str

friendlyName: NotRequired[str]

ressortId: NotRequired[kickerde_api_client.model.core.RessortId]

ressortIdHome: NotRequired[kickerde_api_client.model.core.RessortIdHome]

trackRessortId: NotRequired[kickerde_api_client.model.core.TrackRessortId]

trackRessortName: NotRequired[str]

priority: NotRequired[int]

tblcalc: NotRequired[TableCalculatorType]

tickerQuoteAd: NotRequired[bool]

gamedayQuoteAd: NotRequired[bool]

gamedayButtonTitle: NotRequired[str]

socialmedia: NotRequired[bool]

goalgetters: NotRequired[bool]

history: NotRequired[bool]

hasTransfers: NotRequired[bool]

adKeywords: NotRequired[str]

class kickerde_api_client.model.league.Season

Bases: TypedDict

Upstream model for the season of a league or tournament.

id: SeasonId

currentRoundId: int

displayKey: int

displayKey2: int

table: NotRequired[int]

winnerId: kickerde_api_client.model.team.TeamId | Literal[0]

winnerLongName: NotRequired[str]

points: NotRequired[str]

goals: NotRequired[str]

class kickerde_api_client.model.league.Gameday

Bases: TypedDict

Upstream model for a match day.

id: GamedayId

title: str

dateFrom: NotRequired[datetype.NaiveDateTime]

dateTo: NotRequired[datetype.NaiveDateTime]

hideForTable: NotRequired[bool]

class kickerde_api_client.model.league.LeagueSeason

Bases: TypedDict

Upstream model for a hierarchical view on a league in a season. Contains teams and match days (dubbed gamedays) as submappings.

Submappings are indexed by team ID or gameday ID, respectively.

id: kickerde_api_client.model.league_id.LeagueId

shortName: str

longName: str

country: NotRequired[kickerde_api_client.model.core.Country]

teamType: str

teams: collections.abc.Mapping[kickerde_api_client.model.team.TeamId, kickerde_api_client.model.team.Team]

gamedays: collections.abc.Mapping[GamedayId, Gameday]

iconSmall: str

iconBig: str

currentSeasonId: SeasonId

currentRoundId: int

displayKey: int

displayKey2: int

table: NotRequired[int]

ressortId: NotRequired[kickerde_api_client.model.core.RessortId]

ressortIdHome: NotRequired[kickerde_api_client.model.core.RessortId]

tblcalc: NotRequired[TableCalculatorType]

socialmedia: NotRequired[bool]

syncMeinKicker: NotRequired[bool]

goalgetters: bool

class kickerde_api_client.model.league.LeagueTableEntry

Bases: TypedDict

Upstream model for an entry in a league table.

id: kickerde_api_client.model.team.TeamId

rank: int

The numeric rank of the table entry.

Note that in the context of the league table that contains this entry, the values of rank may be non-unique (due to ties) and sparse (also due to ties, or because the league table might represent a focused subwindow of an actual league table).

shortName: str

longName: str

sortName: str

defaultLeagueId: kickerde_api_client.model.league_id.LeagueId

games: int

goalsFor: int

goalsAgainst: int

wins: int

ties: int

lost: int

points: int

direction: Literal['up', 'down'] | None

winsOvertime: int

winsPenalty: int

lostOvertime: int

lostPenalty: int

groupId: GroupId | None

groupName: str | None

divisionId: DivisionId | None

divisionName: str | None

conferenceId: ConferenceId | None

conferenceName: str | None

iconSmall: str

iconBig: str

class kickerde_api_client.model.league.LeagueTable

Bases: TypedDict

Upstream model for a league table.

id: LeagueTableId

leagueId: kickerde_api_client.model.league_id.LeagueId

name: str

seasonId: SeasonId

roundId: int

entries: dict[kickerde_api_client.model.team.TeamId, LeagueTableEntry]

Dictionary containing LeagueTableEntry objects, ordered by rank but indexed by team ID.

See LeagueTableEntry.rank for details on why this dictionary is indexed by team rather than by rank.