Head to Head

Request: GET

Returns a list of matches (plus statistics) that the two teams have played against eachother in.

HTTP Request

GET /v1/{sport}/matches/headtohead/teams/{teamId}/versus/{teamId}

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
teamId integer Unique identifier for a team in the head to head.
Optional Parameters
competitionId integer Unique identifier for the competition.
competitionStandard string Unique identifier for the competition.
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
 
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
venueId integer Unique identifier for the venue.
useExternalForLeague integer If this value is set to the leagueId of the matches, then the URL parameters teamId and competitionId will instead refer to the externalId fields of their respective entities in that league.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns an array of Head to Head resources. This array is sorted in descending order of match date (UTC).