thesportsdb-client
    Preparing search index...

    Interface Event

    A game, match, race or other event. Also used for video highlights.

    Schedules and lists fill fewer fields than a lookup by id: v1 eventsseason.php and v2 schedule/... leave out descriptions, officials, spectators and the like.

    Times: [timestamp], [date] and [time] are UTC. [localDate] and [localTime] are the venue's local time and are often missing for future events.

    interface Event {
        alternateName: string | null;
        apiFootballId: number | null;
        awayScore: number | null;
        awayScoreExtra: number | null;
        awayTeam: string | null;
        awayTeamBadge: string | null;
        awayTeamId: number | null;
        banner: string | null;
        city: string | null;
        country: string | null;
        date: string | null;
        description: string | null;
        fanart: string | null;
        filename: string | null;
        group: string | null;
        homeScore: number | null;
        homeScoreExtra: number | null;
        homeTeam: string | null;
        homeTeamBadge: string | null;
        homeTeamId: number | null;
        id: number | null;
        isLocked: boolean | null;
        isPostponed: boolean | null;
        kind: "Event";
        league: string | null;
        leagueBadge: string | null;
        leagueId: number | null;
        localDate: string | null;
        localTime: string | null;
        map: string | null;
        name: string | null;
        official: string | null;
        poster: string | null;
        rating: number | null;
        ratingVotes: number | null;
        raw: RawRecord;
        resultText: string | null;
        round: number | null;
        season: string | null;
        spectators: number | null;
        sport: string | null;
        square: string | null;
        stage: RoundStage | null;
        status: EventStatus;
        statusCode: string | null;
        thumb: string | null;
        time: string | null;
        timestamp: Date | null;
        tweet: string | null;
        venue: string | null;
        venueId: number | null;
        video: string | null;
        weather: string | null;
    }

    Hierarchy (View Summary)

    Index
    alternateName apiFootballId awayScore awayScoreExtra awayTeam awayTeamBadge awayTeamId banner city country date description fanart filename group homeScore homeScoreExtra homeTeam homeTeamBadge homeTeamId id isLocked isPostponed kind league leagueBadge leagueId localDate localTime map name official poster rating ratingVotes raw resultText round season spectators sport square stage status statusCode thumb time timestamp tweet venue venueId video weather
    alternateName: string | null

    strEventAlternate, e.g. Chelsea @ Arsenal

    apiFootballId: number | null

    idAPIfootball

    awayScore: number | null

    intAwayScore

    awayScoreExtra: number | null

    intAwayScoreExtra

    awayTeam: string | null

    strAwayTeam

    awayTeamBadge: string | null

    strAwayTeamBadge

    awayTeamId: number | null

    idAwayTeam

    banner: string | null

    strBanner

    city: string | null

    strCity

    country: string | null

    strCountry

    date: string | null

    dateEvent (UTC) (YYYY-MM-DD)

    description: string | null

    strDescriptionEN

    fanart: string | null

    strFanart

    filename: string | null

    strFilename: {league} {date} {home} vs {away}, searchable with searchfilename.php

    group: string | null

    strGroup: a cup group or conference

    homeScore: number | null

    intHomeScore: null until the event has a score

    homeScoreExtra: number | null

    intHomeScoreExtra: extra time or shoot-out

    homeTeam: string | null

    strHomeTeam

    homeTeamBadge: string | null

    strHomeTeamBadge

    homeTeamId: number | null

    idHomeTeam

    id: number | null

    idEvent

    isLocked: boolean | null

    strLocked

    isPostponed: boolean | null

    strPostponed

    kind: "Event"
    league: string | null

    strLeague

    leagueBadge: string | null

    strLeagueBadge

    leagueId: number | null

    idLeague

    localDate: string | null

    dateEventLocal: the venue's local date (YYYY-MM-DD)

    localTime: string | null

    strTimeLocal: the venue's local time (HH:MM:SS)

    map: string | null

    strMap

    name: string | null

    strEvent, e.g. Arsenal vs Chelsea

    official: string | null

    strOfficial: the referee

    poster: string | null

    strPoster

    rating: number | null

    intScore: the users' rating of the event

    ratingVotes: number | null

    intScoreVotes

    raw: RawRecord

    Every field as the API sent it (blank strings as null). Use it for unmodelled fields: team.raw["strKeywords"].

    resultText: string | null

    strResult: free-text result, sometimes with HTML <br>

    round: number | null

    intRound: matchday or round number, or a stage code (125 quarter-final … 500 pre-season); see [stage]

    season: string | null

    strSeason

    spectators: number | null

    intSpectators

    sport: string | null

    strSport

    square: string | null

    strSquare

    stage: RoundStage | null

    The stage when round is a stage code (e.g. 200 = final), or null for an ordinary round.

    status: EventStatus

    The status code read as a broad status.

    statusCode: string | null

    strStatus: the raw code (NS, 2H, FT, Q3, PST...); see [status]

    thumb: string | null

    strThumb

    time: string | null

    strTime (UTC) (HH:MM:SS)

    timestamp: Date | null

    strTimestamp: the start time (UTC) (UTC)

    tweet: string | null

    strTweet1

    venue: string | null

    strVenue

    venueId: number | null

    idVenue

    video: string | null

    strVideo: a highlights video, usually YouTube

    weather: string | null

    strWeather

    Settings
    Member Visibility

    On This Page
    Properties