thesportsdb-client
    Preparing search index...

    Interface V1Lists

    Lists.

    interface V1Lists {
        countries(): Promise<Country[]>;
        leagues(): Promise<League[]>;
        leaguesInCountry(country: string, sport?: string): Promise<League[]>;
        players(teamId: number): Promise<Player[]>;
        seasons(
            leagueId: number,
            extra?: { badges?: boolean; descriptions?: boolean; posters?: boolean },
        ): Promise<Season[]>;
        sports(): Promise<Sport[]>;
        teamsInCountry(sport: string, country: string): Promise<Team[]>;
        teamsInLeague(leagueName: string): Promise<Team[]>;
    }
    Index
    countries leagues leaguesInCountry players seasons sports teamsInCountry teamsInLeague

    • all_leagues.php: id, name, sport (alternate names with a premium key only). Free keys: 5.

      Returns Promise<League[]>

    • search_all_leagues.php?c=&s=: full records (the record key really is "countries").

      Parameters

      • country: string
      • Optionalsport: string

      Returns Promise<League[]>

    • lookup_all_players.php?id=: a team's squad. Free keys: 10.

      Parameters

      • teamId: number

      Returns Promise<Player[]>

    • search_all_seasons.php?id=: names, plus one of badges, posters or descriptions.

      Parameters

      • leagueId: number
      • extra: { badges?: boolean; descriptions?: boolean; posters?: boolean } = {}

      Returns Promise<Season[]>

    • search_all_teams.php?s=&c=. Free keys: 10.

      Parameters

      • sport: string
      • country: string

      Returns Promise<Team[]>

    • search_all_teams.php?l=: a league's teams by league name (not lookup_all_teams.php, which returns another league). Free keys: 10.

      Parameters

      • leagueName: string

      Returns Promise<Team[]>

    Settings
    Member Visibility

    On This Page
    Methods