Competition
Parameter Name Value Description Required
competitionId integer Unique identifier for the competition readonly
competitionName string The name of the competition required
competitionAbbrev string An abbreviation for this competition  
competitionNameInternational string The name of the competition suitable for international purposes. Latin characters only.  
competitionAbbrevInternational string An abbreviated form of the name of the competition suitable for international purposes. Latin characters only.  
season string Season for this competition  
leagueId integer Unique identifier for the league who looks after this competition. readonly
leagueName string league name readonly
linkDetailLeague url link to the league detail record readonly
year string The starting year of the competition. 4 digits required
startDate date The starting date of the competition. YYYY-MM-DD  
endDate date The end date of the competition. YYYY-MM-DD  
twitter string The public twitter account for the competition  
facebook string The public facebook account for the competition  
keywords string A comma-separated string of keywords relevant to this competition.  
externalId string A unique ID for this competition set by the owner of this competition.  
numberCompetitors integer Number of competititors per match. Default = 2  
current integer Is this competition current for the 'season'. 1=Yes, 0=No.  
gender string The gender of the competition.
  • MALE Male
  • FEMALE Female
  • MIXED Both male and female
  
ageGroup string The rough age group of the competition.
  • JUNIOR Child/Teenage (below 18)
  • SENIOR Adult, 18+
  • MASTERS More senior ages, 40+
  
representation string Who are the competitors in this competition representating
  • COUNTRY A nation/country
  • CLUB A club/team - Default
standard string The level/standard of this competition. Options are:

Only valid if representation is 'country'
  • OLYMPICS Olympics
  • WORLD_CHAMPIONSHIPS World Championships
  • ZONE_CHAMPIONSHIPS International Zone Championships
  • NONCONTINENTAL_CHAMPIONSHIPS Non-Continental Championships
  • FRIENDLIES International Friendlies
Only valid if representation is 'club'
  • INTERNATIONAL International
  • REGION Regional
  • ELITE Professional/elite organisation
  • TIER2 - lesser standard than elite
  • TIER3 - lesser standard than tier 2
  • GRASS_ROOTS (Default) - normal standard
 required
competitionOrder integer Competition order within grouping key  
groupingOrder integer grouping key order  
groupingKey string grouping display key  
grade string The grade/level of the competition in this league  
competitorType string The type of competitor in this competition
  • TEAM This competition is team based
  • PLAYER This competition is player based
 required
includeInCareerStatistics integer Normally player match statistics are automatically aggregated in to career statistics. If this value is set to 0, then any matches in this competition will not be included in the person's career statistics. This value defaults to 1.  
notes text competition notes
linkDetail url link to the detail record readonly
numberOfPeriods integer The number of periods in a match, not including any over/extra time
periodLength integer The length of each period (in minutes)
extraTime integer Whether a match in this competition can play overtime? 1=Yes, 0=No.
extraTimeLength integer The length of each overtime period (in minutes)
finalsPositions integer The number of competitors that compete in the finals series
ticketURL string URL of ticket purchasing  
images
logo structure The files sub-structure from the Upload Resource. Only present if this competition has a logo that has been uploaded. readonly