Function fetch

fetch(league: League, options?: ScoreboardOptions): Promise<BaseScoreboard>

Fetch scoreboard data for a given League

Parameters

league: League
Optionaloptions: ScoreboardOptions
Optional query parameters for filtering

Returns Promise<BaseScoreboard>

Example

import { Scoreboard, Enums } from '@mikelaferriere/espn-api';

const scoreboard = await Scoreboard.fetch(Enums.League.NHL);
console.log(scoreboard);

// With options
const nflWeek = await Scoreboard.fetch(Enums.League.NFL, { week: 5, year: 2023, seasontype: 2 });
const dateRange = await Scoreboard.fetch(Enums.League.MLB, { dates: '20240101-20240131' });