Skip to content

Weekly races

Use weeklyRaces to get the current weekly race or request one by ID.

weeklyRaces.current()

Gets the current weekly race.

weeklyRaces.current(): Promise<WeeklyRace>
const race = await mcsrranked.weeklyRaces.current();
console.log(race.leaderboard);

weeklyRaces.get()

Gets a weekly race by its numeric ID.

weeklyRaces.get(id: number): Promise<WeeklyRace>
Parameter Type Description
id number Weekly race ID
const race = await mcsrranked.weeklyRaces.get(12);

WeeklyRace contains the race ID, seed settings, end time, and leaderboard. Each leaderboard entry includes the rank, player, completion time, and whether a replay exists.

For a task-based example, read work with live matches and weekly races.