League Service

League Service

The League service provides comprehensive access to league management, rosters, seasons, standings, and sessions.

const leagueService = iracing.league;

Methods

get(params)

Get detailed information about a league.

Details

Returns: Promise<LeagueGetResponse>

Parameters:

• leagueId: number (required) - The league ID
• includeLicenses?: boolean - Include license information for members

Description: Returns detailed information about a specific league.

Example

const league = await iracing.league.get({
  leagueId: 1234,
  includeLicenses: true
});

console.log(`${league.leagueName}`);
console.log(`Owner: ${league.ownerDisplayName}`);

---

directory(params?)

Search the league directory.

Details

Returns: Promise<LeagueDirectoryResponse>

Parameters:

• search?: string - Search term for league name
• tag?: string - Filter by tag
• restrictToMember?: boolean - Only leagues you belong to
• restrictToRecruiting?: boolean - Only leagues currently recruiting
• restrictToFriends?: boolean - Only leagues with friends
• restrictToWatched?: boolean - Only watched leagues
• minimumRosterCount?: number - Minimum number of members
• maximumRosterCount?: number - Maximum number of members
• lowerbound?: number - Lower bound for pagination
• upperbound?: number - Upper bound for pagination
• sort?: string - Sort field
• order?: string - Sort order

Description: Searches the league directory with various filtering and sorting options.

Example

// Search for leagues by name
const leagues = await iracing.league.directory({
  search: 'Endurance',
  restrictToRecruiting: true
});

// Get your leagues
const myLeagues = await iracing.league.directory({
  restrictToMember: true
});

---

membership(params?)

Get league membership information.

Details

Returns: Promise<LeagueMembershipResponse>

Parameters:

• custId?: number - Customer ID (defaults to authenticated user)
• includeLeague?: boolean - Include full league details

Description: Returns the leagues that a member belongs to.

Example

// Get your own memberships
const memberships = await iracing.league.membership({
  includeLeague: true
});

// Get another member's memberships
const otherMemberships = await iracing.league.membership({
  custId: 123456
});

---

roster(params)

Get a league’s roster.

Details

Returns: Promise<LeagueRosterResponse>

Parameters:

• leagueId: number (required) - The league ID
• includeLicenses?: boolean - Include license information

Description: Returns the full member roster for a league.

Example

const roster = await iracing.league.roster({
  leagueId: 1234,
  includeLicenses: true
});

roster.members.forEach(member => {
  console.log(`${member.displayName} (ID: ${member.custId})`);
});

---

seasons(params)

Get a league’s seasons.

Details

Returns: Promise<LeagueSeasonsResponse>

Parameters:

• leagueId: number (required) - The league ID
• retired?: boolean - Include retired seasons

Description: Returns all seasons for a league, optionally including retired ones.

Example

const seasons = await iracing.league.seasons({
  leagueId: 1234,
  retired: false
});

seasons.forEach(season => {
  console.log(`${season.seasonName} (ID: ${season.seasonId})`);
});

---

seasonStandings(params)

Get standings for a league season.

Details

Returns: Promise<LeagueSeasonStandingsResponse>

Parameters:

• leagueId: number (required) - The league ID
• seasonId: number (required) - The season ID
• carClassId?: number - Filter by car class
• carId?: number - Filter by car

Description: Returns the points standings for a specific league season.

Example

const standings = await iracing.league.seasonStandings({
  leagueId: 1234,
  seasonId: 5678
});

standings.forEach(entry => {
  console.log(`${entry.position}. ${entry.displayName}: ${entry.points} pts`);
});

---

seasonSessions(params)

Get sessions for a league season.

Details

Returns: Promise<LeagueSeasonSessionsResponse>

Parameters:

• leagueId: number (required) - The league ID
• seasonId: number (required) - The season ID
• resultsOnly?: boolean - Only return sessions with results

Description: Returns all scheduled and completed sessions for a league season.

Example

const sessions = await iracing.league.seasonSessions({
  leagueId: 1234,
  seasonId: 5678,
  resultsOnly: true
});

sessions.forEach(session => {
  console.log(`${session.sessionName} - ${session.launchAt}`);
});

---

getPointsSystems(params)

Get points systems for a league.

Details

Returns: Promise<LeagueGetPointsSystemsResponse>

Parameters:

• leagueId: number (required) - The league ID
• seasonId?: number - Filter to a specific season

Description: Returns the custom points systems configured for a league.

Example

const pointsSystems = await iracing.league.getPointsSystems({
  leagueId: 1234
});

pointsSystems.forEach(system => {
  console.log(`${system.name}: ${system.description}`);
});

---

custLeagueSessions(params?)

Get the customer’s league sessions.

Details

Returns: Promise<LeagueCustLeagueSessionsResponse>

Parameters:

• mine?: boolean - Only show your sessions
• packageId?: number - Filter by content package

Description: Returns league sessions relevant to the authenticated member.

Example

const sessions = await iracing.league.custLeagueSessions({
  mine: true
});

sessions.forEach(session => {
  console.log(`${session.leagueName} - ${session.sessionName}`);
});

Common Use Cases

Get Complete League Info

async function getLeagueOverview(leagueId: number) {
  const [league, roster, seasons] = await Promise.all([
    iracing.league.get({ leagueId }),
    iracing.league.roster({ leagueId }),
    iracing.league.seasons({ leagueId }),
  ]);

  return {
    name: league.leagueName,
    memberCount: roster.members.length,
    activeSeasons: seasons.filter(s => !s.retired),
  };
}

See Also

• Results Service - Race results for league sessions
• Member Service - Member profile data
• Services Overview - All available services