SportriX Match Object — REST API Schema Reference

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/{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.

Status values

`status`	Meaning
`NOT_STARTED`	Scheduled, not yet kicked off
`STARTED`	In play (including half-time)
`FINISHED`	Completed

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

Example

{
  "id": 41301,
  "home_team": "Salmon Bay FC (W)",
  "away_team": "West Seattle Rhodies FC (W)",
  "start_time": "2026-06-18T02:00:00Z",
  "status": "NOT_STARTED"
}

​Used by

​Fields

​Status values

​Example

Used by

Fields

Status values

Example