thesportsdb-client
    Preparing search index...

    Interface V1Search

    Search endpoints. Free keys: one result each.

    interface V1Search {
        events(
            name: string,
            options?: { date?: Day; season?: string },
        ): Promise<Event[]>;
        eventsByFilename(filename: string, season?: string): Promise<Event[]>;
        players(name: string): Promise<Player[]>;
        teams(name: string): Promise<Team[]>;
        venues(name: string): Promise<Venue[]>;
    }
    Index
    events eventsByFilename players teams venues

    • searchevents.php?e=: events by name, "Home vs Away". Narrow with a season or a date, not both.

      Parameters

      • name: string
      • options: { date?: Day; season?: string } = {}

      Returns Promise<Event[]>

    • searchfilename.php?e=: events by Event.filename, e.g. "English Premier League 2015-04-26 Arsenal vs Chelsea".

      Parameters

      • filename: string
      • Optionalseason: string

      Returns Promise<Event[]>

    • searchplayers.php?p=: players by name (summary fields).

      Parameters

      • name: string

      Returns Promise<Player[]>

    • searchteams.php?t=: teams by name.

      Parameters

      • name: string

      Returns Promise<Team[]>

    Settings
    Member Visibility

    On This Page
    Methods