Head to Head matches
Parameter Name Value Description Required
leagueId integer Unique identifier for the league  
competitionId integer Unique identifier for the competition  
competitionName string competition name  
matchId integer Unique identifier for the match  
externalId string A unique ID for this match set by the owner of this league.  
matchType string What part of the competition is this match part of. If not specified the value of this field for the round will be checked.
  • PRESEASON Pre Season
  • REGULAR Regular matches - Default
  • FINALS Finals/Playoffs
  
linkDetailCompetition string link to the competition detail record  
linkDetail string link to the detail record  
matchStatus string match status
  • BYE Bye (generally only assign 1 match competitor)
  • SCHEDULED Scheduled
  • IN_PROGRESS In Progress
  • FINISHED Finished
  • COMPLETE Results Complete
  • POSTPONED Postponed
  • CANCELLED Cancelled
 
matchTime datetime The start date/time of the match YYYY-MM-DD HH:MM:SS  
matchTimeUTC datetime The start date/time of the match YYYY-MM-DD HH:MM:SS in the UTC timezone  
extraPeriodsUsed integer Number of extra time periods used in Match  
competitors
competitorName string name of the competitor  
linkDetailCompetitor url Unique URL to detail record of the competitor  
competitorType string Type of competitor
  • TEAM Team based competition
  • PLAYER Individual based competition
  
clubName string The name of the competitor's club  
scoreString string Score string for each competitor  
scoreSecondaryString string Score Secondary string for each competitor  
isHomeCompetitor integer Are they the home competitor ? 1=Yes, 0=No.  
isDrawn integer in a draw for the resultPlacing ? 1=Yes, 0=No.  
externalId string The externalId of the competitor.