Available Matches

Request: GET

Returns a list of matches that the user has access to that are configured to be livestreamed. This call can span multiple leagues/competitions if the user has the allowed access.

HTTP Request

GET /v1/{sport}/stream/matches
GET /v1/{sport}/stream/leagues/{leagueId}/matches

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
Optional Parameters
leagueId integer Unique identifier for the league the match belongs to.
phaseName string phase/stage name for pools
poolNumber integer pool number
fromDate date from date range to filter matches
toDate date to date range to filter matches
fromDateUTC date from date range to filter matches
toDateUTC date to date range to filter matches
roundNumber string round number
venueId integer Unique identifier for the venue where the match takes place
venueRating integer Each venue is given a rating between 0-5 of how reliable it's livestream connection is. 0 = not reliable, 5 - always reliable. If a number is given here then only matches at a venue equal or more reliable than the given number are shown.
teamId integer show if team is a competitor in this match
clubId integer show if club is a competitor in this match
personId integer show if person is a competitor in this match (only used if competition is a non team based competition)
matchType string What part of the competition is this match part of.
  • PRE Pre Season
  • REGULAR Regular matches - Default
  • FINALS Finals/Playoffs

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a list of Match resources.