Returns a list of matches that the user has access to. The data returned will also give the current state of the match (if in progress).
Note - This is additional functionality beyond the standard API functionality. Additional permissions are required on the API key. There may be additional costs involved.
The data in this call is updated once per minute, the API call should not be made more frequent than that.
GET /v1/{sport}/competitions/{competitionId}/matcheslive
| Parameter Name | Value | Description |
|---|---|---|
| Required Parameters | ||
sport |
string |
The sport for which you are making the request |
competitionId |
integer |
Unique identifier for the competition the match belongs to. |
| Optional Parameters | ||
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 |
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.
|
liveStream |
integer |
Will the match be live streamed? 1=Yes, 0=No. |
useExternalForLeague |
integer |
If this value is set to the leagueId for the team, then the URL filter parameters competitionId, venueId, teamId, clubId, personId will instead refer to the externalId fields of the respective entities in that league. |
Do not supply a request body with this method.
If successful this method returns a list of Match (with Live) resources.