Match

Parameter Name	Value	Description	Required
matchId	integer	Unique identifier for the match	readonly
matchNumber	integer	The number of the match	required
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	readonly
leagueName	string	league name	readonly
linkDetailLeague	string	link to the league detail record	readonly
competitionId	integer	Unique identifier for the competition	readonly
competitionName	string	competition name	readonly
competitionNameInternational	string	competition name suitable for international use. Latin characters only	readonly
linkDetailCompetition	string	link to the competition detail record	readonly
linkDetail	string	link to the detail record	readonly
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	readonly
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
streamKey	string	The key needed to livestream this match with the livestream publish API. Will only be included if the user has permission.
ticketURL	string	URL of ticket purchasing
venue Only present if a venue is defined for the match. This section is readonly. venueId integer A unique ID for the venue readonly venueName string The name of the venue readonly venueNameInternational string The name of the venue suitable for international use. Latin characters only readonly venueNickname string The nickname of the venue readonly venueNicknameInternational string The nick name of the venue suitable for international use. Latin characters only readonly surfaceName string The name of the surface readonly locationName string The name of the location readonly website url The url of the venue's websitelocation readonly externalId integer The externalId of the venue readonly ticketURL url The ticketing URL of the venue readonly linkDetailVenue string link to the venue detail record readonly
competitors (Rows are returned in random order) competitorName string name of the competitor readonly linkDetailCompetitor url Unique URL to detail record of the competitor readonly competitorType string Type of competitor TEAM Team based competition PLAYER Individual based competition required clubName string The name of the competitor's club readonly clubNameInternational string The name of the competitor's club suitable for international use. Latin characters only. readonly clubId integer The unique identifier of the competitor's club readonly linkDetailCompetitorClub url Unique URL to detail record of the competitor's club readonly linkDetailCompetitorMatchStatistics url Unique URL to detail record of the competitor's match statistics readonly 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. required teamName string Name of the team. Only present if competitorType is TEAM. readonly teamCode string Code for the team. Only present if competitorType is TEAM. readonly teamNickname string Nickname of the team. Only present if competitorType is TEAM. readonly teamNameInternational string Name of the team suitable for international use. Latin characters only. Only present if competitorType is TEAM. readonly teamCodeInternational string Code for the team suitable for international use. Latin characters only. Only present if competitorType is TEAM. readonly teamNicknameInternational string Nickname of the team suitable for international use. Latin characters only. Only present if competitorType is TEAM. readonly website url The website of the competitor. readonly externalId string The externalId of the competitor. readonly internationalReference string The internationalReference of the competitor. readonly familyName string Only present if competitorType is PERSON. readonly firstName string Only present if competitorType is PERSON. readonly internationalFamilyName string Only present if competitorType is PERSON. readonly internationalFirstName string Only present if competitorType is PERSON. readonly scoreboardName string Only present if competitorType is PERSON. readonly TVName string Only present if competitorType is PERSON. readonly