Get Matches [V1]

Returns a paginated list of matches. Supports filtering by status, team, competition, and date range.

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

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
Defaults to 1000

The number of items to return per page.

string
Defaults to date

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

date-time

Returns matches that started after this date. Must follow ISO 8601 format.

date-time

Returns matches that started before this date. Must follow ISO 8601 format.

boolean
Defaults to false

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

string
enum
Defaults to opta

The provider that the data was received from

Allowed:
string
Defaults to GLOBAL

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

status
array of strings

Return matches that only match the required statuses, can be passed as a comma-delimited list (&status=X,Y) or as multiple parameters (&status=X&status=Y). Can be live, result, fixture and postponed. Default will return live, result and fixture

status
integer

Return only matches for a given team

compId
array of integers

Returns matches for a given list of competition IDs. Can be sent as a comma-delimited list (&compId=X,Y) or as multiple parameters (&compId=X&compId=Y)

compId
Responses

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