Skip to main content
The Match object is the core catalog record for a fixture. It gives you the identifying information you need to look up live scores, subscribe to the WebSocket stream, or fetch a final result.

​
Used by

  • GET /matches
  • GET /matches/active
  • GET /matches/live
  • GET /matches/{id}

​
Fields

​
integer
required
Match id. Use this value as the match_id parameter for GET /matches/{id}/live, GET /matches/{id}/result, and WebSocket subscribe/unsubscribe messages.
​
string
required
Home team name.
​
string
required
Away team name.
​
datetime
required
Scheduled kick-off time in ISO 8601 UTC, e.g. 2026-06-18T02:00:00Z.
​
string
required
Current match status. One of the three values below.
​
string
Optional. The data provider’s fixture description text, e.g. "Arsenal v Chelsea". SportriX omits this field from the response when the provider description is blank, so it is not present on every match. Check for the key before you read it, and fall back to home_team and away_team when it is missing.

​
Status values

Suspended or postponed matches are never returned by the API. They are filtered out of every catalog response.

​
Example

The same match with a blank provider description has no description key:
Earlier API versions returned an undocumented extra_details object on matches. The API no longer returns it. Use description instead.