Competition Types & Entities

(Enum) Competition Type

'classic', 'team'

(Enum) Competition Status

'upcoming', 'ongoing', 'finished'

(Enum) Competition CSV Table Type

'team', 'teams', 'participants'

(Object) Competition Progress

Field	Type	Description
start	integer	A player's start value for the competition's metric.
end	integer	A player's end value for the competition's metric.
gained	integer	A player's gained value for the competition's metric.

(Object) Competition Levels Progress

Field	Type	Description
start	integer	A player's start level for the competition's metric.
end	integer	A player's end level for the competition's metric.
gained	integer	A player's gained levels for the competition's metric.

(Object) Competition Delta

Field	Type	Description
metric	Metric | "total"	The metric this delta is for, or "total" for the combined delta across all the selected metrics. (The "total" entry is only present when more than one metric is selected)
values	CompetitionProgress	The player's progress for this metric.
levels	CompetitionLevelsProgress	The player's levels progress for this metric.

(Object) Competition Metric

Field	Type	Description
metric	Metric	The metric.
weight	number	The metric's weight towards the competition's combined "total" progress.
createdAt	date	The date at which this metric was added to the competition.

(Object) Competition

Field	Type	Description
id	integer	The competition's unique ID.
title	string	The competition's title.
metric	Metric	(⚠️ Deprecated, use metrics instead) The competition's first metric.
metrics	CompetitionMetric[]	The competition's metrics. (Multiple entries for multi-metric competitions)
type	CompetitionType	The competition's type.
startsAt	date	The competition's start date.
endsAt	date	The competition's end date.
groupId	integer?	The competition's host group ID.
score	integer	The competition's global ranking score.
createdAt	date	The competition's creation date.
updatedAt	date	The competition's last modification date.
participantCount	number	The competition's total number of participants.
group	Group	The competition's host group.

(Object) Participation

Field	Type	Description
playerId	integer	The player's ID.
competitionId	integer	The competition's ID.
teamName	string?	The name of the team the player is in. (Only applicable to team competitions)
createdAt	date	The date at which the player was added as a participant to the competition.
updatedAt	date	The date at which the participation was updated.

(Object) Competition Participation

Returned in competition-centric endpoints.

extends Participation

Field	Type	Description
player	Player	The participation's player.

(Object) Player Participation

Returned in player-centric endpoints.

extends Participation

Field	Type	Description
competition	Competition	The competition the player is competing in.

(Object) Player Competition Standing

extends PlayerParticipation

Field	Type	Description
progress	CompetitionProgress	The player's progress in the competition.
levels	CompetitionLevelProgress?	The player's levels progress in the competition. (Only exists in skilling competitions)
rank	number	The player's rank in the competition.

(Object) Competition Participation Details

extends CompetitionParticipation

Field	Type	Description
deltas	CompetitionDelta[]	The player's progress, broken down by metric. Includes a "total" entry when more than one metric is selected.
progress	CompetitionProgress	(⚠️ Deprecated, use deltas instead) The player's progress in the metric the competition is ranked by.
levels	CompetitionLevelProgress?	(⚠️ Deprecated, use deltas instead) The player's levels progress in the metric the competition is ranked by. (Only exists in skilling competitions)

(Object) Competition Details

extends Competition

Field	Type	Description
participations	CompetitionParticipationDetails	The competition's participants, and all their progress.

(Object) Participant History Datapoint

Field	Type	Description
value	number	The player's value for the competition metric, at a specific point in time.
date	date	The date at which the datapoint was recorded.

(Object) Participant History

Field	Type	Description
player	Player	The participant.
history	ParticipantHistoryDataPoint	The participant's history throughout the competition.

(Object) Team

Field	Type	Description
name	string	The team's name.
participants	string[]	The team's participants' usernames.

(Object) Competition With Participations

extends Competition

Field	Type	Description
participations	CompetitionParticipation[]	The competition's participants.