Returns a list of all participants from a single race by given ID (if it exists).
Race is identified by its stringified ObjectID.
ObjectID
dnf
startDate
endDate
score
const raceId: string = "5f5e555d5a578b6";const participantsAll: RacePlayer[] = await sdk.getRaceParticipantsList({ raceId });const participantsDnf: RacePlayer[] = await sdk.getRaceParticipantsList({ raceId, filter: { dnf: true }});const participantsLeaderboards: RacePlayer[] = await sdk.getRaceParticipantsList({ raceId, sort: { score: 'desc' }});
Generated using TypeDoc
Returns a list of all participants from a single race by given ID (if it exists).
Race is identified by its stringified
ObjectID
.Filter options
dnf
- filter participants by their status of finishing the race.Sort options
startDate
- sort participants by their start dateendDate
- sort participants by their end datescore
- sort participants by their scoreUsage