kickerde_api_client.model.match =============================== .. py:module:: kickerde_api_client.model.match .. autoapi-nested-parse:: Upstream model for sports matches and their state. Attributes ---------- .. autoapisummary:: kickerde_api_client.model.match.MatchId kickerde_api_client.model.match.TeamToken Classes ------- .. autoapisummary:: kickerde_api_client.model.match.MatchTeam kickerde_api_client.model.match.MatchResults kickerde_api_client.model.match.ApprovalId kickerde_api_client.model.match.Period kickerde_api_client.model.match.Match Module Contents --------------- .. py:data:: MatchId :type: TypeAlias :value: int Upstream ID for a sports match. .. py:data:: TeamToken :type: TypeAlias :value: str Three- to four-letter abbreviation for a match participant. .. py:class:: MatchTeam Bases: :py:obj:`TypedDict` Upstream model for a sports team that takes part in a match. .. py:attribute:: id :type: kickerde_api_client.model.team.TeamId .. py:attribute:: defaultLeagueId :type: kickerde_api_client.model.league_id.LeagueId .. py:attribute:: shortName :type: str .. py:attribute:: longName :type: str .. py:attribute:: urlName :type: str .. py:attribute:: iconSmall :type: str .. py:attribute:: iconBig :type: str .. py:attribute:: token :type: TeamToken .. py:class:: MatchResults Bases: :py:obj:`TypedDict` Upstream model for the results of a sports match. .. py:attribute:: hergAktuell :type: int Current standings for the home team. .. py:attribute:: aergAktuell :type: int Current standings for the away team. .. py:attribute:: hergHz :type: NotRequired[int] Standings for the home team by the end of the first half. .. py:attribute:: aergHz :type: NotRequired[int] Standings for the away team by the end of the first half. .. py:attribute:: hergEnde :type: NotRequired[int] Standings for the home team by the end of the match. .. py:attribute:: aergEnde :type: NotRequired[int] Standings for the away team by the end of the match. .. py:class:: ApprovalId Bases: :py:obj:`enum.IntEnum` Degree of certainty with which a match is scheduled. .. py:attribute:: SCHEDULED :value: 0 The match is tentatively scheduled (`Angesetzt`). .. py:attribute:: CONFIRMED :value: 1 The match schedule is confirmed (`Vorschau`). .. py:attribute:: LIVE :value: 12 The match is currently being played (`Live`). .. py:attribute:: UNKNOWN_13 :value: 13 This value has not been observed in the wild yet. .. py:attribute:: FINISHED :value: 14 The match is over and a report (`Spielbericht`) has been published. .. py:class:: Period Bases: :py:obj:`enum.IntEnum` The degree of progress in a match. .. py:attribute:: BEFORE :value: 0 The match has not started. .. py:attribute:: FIRST_HALF :value: 1 The first half is underway. .. py:attribute:: HALF_TIME :value: 2 The first half has completed. The second half has not started. .. py:attribute:: SECOND_HALF :value: 3 The second half is underway. .. py:attribute:: FINISHED :value: 4 The match is over. .. py:class:: Match Bases: :py:obj:`TypedDict` Upstream model for a sports match. .. py:attribute:: id :type: MatchId .. py:attribute:: leagueId :type: kickerde_api_client.model.league_id.LeagueId .. py:attribute:: leagueShortName :type: str German-language editorial shorthand for the league or tournament. Equivalent to the :py:attr:`~.model.League.shortName` of a :py:class:`~.model.League`. Example: `2.BL` for `2. Bundesliga` .. py:attribute:: leagueLongName :type: str German-language full-name of the league or tournament. Equivalent to the :py:attr:`~.model.League.longName` of a :py:class:`~.model.League`. .. py:attribute:: seasonId :type: kickerde_api_client.model.league.SeasonId .. py:attribute:: roundId :type: int Ordinal of the round, 1-based. Correlates to :py:attr:`.round`, e.g. `roundId` is `18` if `round` is equal to `“18. Spieltag”`. .. py:attribute:: homeTeam :type: MatchTeam .. py:attribute:: guestTeam :type: MatchTeam .. py:attribute:: results :type: NotRequired[MatchResults] .. py:attribute:: date :type: datetype.NaiveDateTime Date and time for which the match is scheduled to begin. Implies a timezone of `Europe/Berlin`. .. py:attribute:: completed :type: bool `True` if the match is over, `False` otherwise. .. py:attribute:: currentMinute :type: int How many minutes of the match have passed. Includes minutes that have started but not completed. Typically equal to 0 if the match has not started. Equal to the duration of the match in minutes if the match is over. .. py:attribute:: currentPeriod :type: Period The phase into which the match has progressed. .. py:attribute:: approvalId :type: ApprovalId Degree of certainty with which this match is scheduled. .. py:attribute:: approvalName :type: str German-language description of the degree of certainty. Correlates with :py:attr:`.approvalId`. Examples: - `Angesetzt` - `Vorschau` - `Live` .. py:attribute:: timeConfirmed :type: bool Whether the association has confirmed the date and time. .. py:attribute:: sportId :type: kickerde_api_client.model.core.SportId Upstream ID for the type of sport. .. py:attribute:: displayKey :type: int Sorting key for editorial purposes. .. py:attribute:: round :type: str German-language display name of the round or match day. Example: `18. Spieltag` .. py:attribute:: leaguePriority :type: int Editorial priority of the league that hosts the match. Equivalent to the :py:attr:`~.model.League.priority` of a :py:class:`~.model.League`. .. py:attribute:: countryId :type: kickerde_api_client.model.core.CountryId Upstream ID for a country that hosts the match. .. py:attribute:: country :type: str German-language name of the country hosting the match. Correlates with :py:attr:`.countryId`. .. py:attribute:: leagueUrlName :type: str URL-friendly league name. Example: ``serie-a`` for `Serie A`. .. py:attribute:: state :type: str German-language description of a purpose, status, or rationale. Example: `Regulär` .. py:attribute:: modifiedAt :type: datetype.NaiveDateTime Server-side timestamp. Implies a timezone of `Europe/Berlin`. .. py:attribute:: currentDateTime :type: datetype.NaiveDateTime Server-side timestamp of when this library has retrieved the data. Implies a timezone of `Europe/Berlin`.