Match - with live scores
Parameter Name Value Description Required
matchId integer Unique identifier for the match  
matchNumber integer The number of the match  
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
  
matchName string The name of the match  
leagueId integer Unique identifier for the league  
leagueName string league name  
linkDetailLeague string link to the league detail record  
competitionId integer Unique identifier for the competition  
competitionName string competition name  
competitionNameInternational string competition name suitable for international use. Latin characters only  
linkDetailCompetition string link to the competition detail record  
linkDetail string link to the detail record  
poolNumber integer The identifier of the pool  
phaseName string phase/stage name for pools  
roundNumber string The identifier of the round. Usually a number, but will support a string eg. 'Grand Final'.  
roundDescription string A description of the round. eg. Rivalry Round  
venueId integer A unique ID for the venue  
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  
enddate date The end date of the match YYYY-MM-DD  
timeActual datetime The actual start time of the match YYYY-MM-DD HH:MM:SS  
timeEndActual datetime The actual end time of the match YYYY-MM-DD HH:MM:SS  
durationActual integer The actual duration of the match (mins) including timeouts and period breaks  
temperature integer The temperature during the match (Degrees Celsius)  
attendance integer Attendance of the match  
duration integer The duration (in minutes) of the match  
weather string Description of the weather during the match  
twitterHashtag string A twitter hashtag for the match  
externalId string A unique ID for this match set by the owner of this league.  
liveStream integer Will the match be available as a live stream. 1=Yes, 0=No. Default No  
ticketURL string URL of ticket purchasing  
live Only present if live data is available for the match.
status string The status of the match.
  • delayed
  • loaded
  • ready
  • inprogress
  • periodbreak
  • interrupted
  • cancelled
  • rescheduled
  • finished
  • protested
  • complete
periodType string The type of period.
  • REGULAR
  • OVERTIME
period integer The period number. Overtime periods start at 1
periodStatus string The status of the period.
  • pending
  • started
  • ended
  • confirmed
clock string The current time on the clock. Format MM:SS:CC
shotClock string The current time on the shot clock. Format MM:SS:CC
clockRunning integer Is the clock running? 1 = yes, 0 = no  
scores array An array of current scores, keyed by home / away team number 'scores. 1 = Home Competitor, 2 = Away Competitor 'scores' : { '1' : 20, '2' : 34 }  
venue Only present if a venue is defined for the match.
venueId integer A unique ID for the venue  
venueName string The name of the venue  
venueNameInternational string The name of the venue suitable for international use. Latin characters only  
venueNickname string The nickname of the venue  
venueNicknameInternational string The nick name of the venue suitable for international use. Latin characters only  
surfaceName string The name of the surface  
locationName string The name of the location  
website url The url of the venue's websitelocation  
externalId integer The externalId of the venue  
ticketURL url The ticketing URL of the venue  
linkDetailVenue string link to the venue detail record  
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  
clubNameInternational string The name of the competitor's club suitable for international use. Latin characters only.  
clubId integer The unique identifier of the competitor's club  
linkDetailCompetitorClub url Unique URL to detail record of the competitor's club  
linkDetailCompetitorMatchStatistics url Unique URL to detail record of the competitor's match statistics  
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.  
completionStatus string Score string for each competitor
  • COMPLETE Complete
  • NOT_COMPLETE Not complete
  • FORFEIT Forfeit
  
placeIfWon integer place if match won  
placeifLost integer place if match lost  
resultPlacing integer result place (1=Won, 2=Lost,3=3rd and so on)  
isDrawn integer in a draw for the resultPlacing ? 1=Yes, 0=No.  
teamId integer Unique identifier for the team. Only present if competitorType is TEAM.  
teamName string Name of the team. Only present if competitorType is TEAM.  
teamCode string Code for the team. Only present if competitorType is TEAM.  
teamNickname string Nickname of the team. Only present if competitorType is TEAM.  
teamNameInternational string Name of the team suitable for international use. Latin characters only. Only present if competitorType is TEAM.  
teamCodeInternational string Code for the team suitable for international use. Latin characters only. Only present if competitorType is TEAM.  
teamNicknameInternational string Nickname of the team suitable for international use. Latin characters only. Only present if competitorType is TEAM.  
website url The website of the competitor.  
externalId string The externalId of the competitor.  
internationalReference string The internationalReference of the competitor.  
familyName string Only present if competitorType is PERSON.  
firstName string Only present if competitorType is PERSON.  
internationalFamilyName string Only present if competitorType is PERSON.  
internationalFirstName string Only present if competitorType is PERSON.  
scoreboardName string Only present if competitorType is PERSON.  
TVName string Only present if competitorType is PERSON.