get Matches

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The provider that the data was received from

integer

Based on the number of items per page [size], it may be required to page through lots of data. The page index is 0-indexed so 0 is the first page of data.

integer

The number of items to return per page.

string

A single sort field, can be any field returned within the object. prefixing the field with a "-" will sort descending, otherwise data is sorted ascending

string

Get matches of a certain status, can be provided as a comma-delimited list (?status=X,Y) or as separate parameters (?status=X&status=Y). Providing no status will return all matches

integer

Get matches for a single team

integer

Get matches for a given round

integer

Get matches for a list of competition IDs, can be provided as a comma-delimited list (?compId=X,Y) or as a set of parameters (?compId=X&compId=Y)

integer

Return matches for a given season

boolean

Override the returned season ID in the data with a pre-defined value, used for internal purposes

string

Return only matches after this date. Follows ISO-8601 notation

string

Return only matches before this date. Follows ISO-8601 notation

boolean

Should the matches contain summary information or not. If set to false, all matches will include matches events and officials, which can lead to large responses.

boolean

Include images for competition and team badges. Used in combination with clientId to indicate whether to use the global image library use a client's images

boolean

Return match history for each team as part of the payload. Will return simply whether the result fo the last X matches (controlled by formSize) was a win/lose or draw

integer

Used in conjunction with form to determine how many previous matches to return.

boolean

If true, will only include match events that are supported by the contract with the provider, these events are: "start", "first half start", "first half end", "second half start", "second half end", "end", "try", "conversion", "drop goal", "missed drop goal", "penalty", "penalty try", "yellow card", "red card", "sub off", "sub on", "missed conversion", "missed penalty"

boolean

Include officals in the match data

string

Used when returning images and for usage tracking. If no client ID is passed, will draw from the global stock images, when a client ID is passed, it will attempt to use a client's version of those images

Headers
string

(Required)

string

(Required)

string

(Required)

string
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json