> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sportrix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Sportrix Data Match Object — REST API Schema Reference

> The Match object is returned by /matches, /matches/active, and /matches/{id}. It contains match id, team names, start time, and current status.

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

<ResponseField name="id" type="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.
</ResponseField>

<ResponseField name="home_team" type="string" required>
  Home team name.
</ResponseField>

<ResponseField name="away_team" type="string" required>
  Away team name.
</ResponseField>

<ResponseField name="start_time" type="datetime" required>
  Scheduled kick-off time in ISO 8601 UTC, e.g. `2026-06-18T02:00:00Z`.
</ResponseField>

<ResponseField name="status" type="string" required>
  Current match status. One of the values below.
</ResponseField>

## Status values

| `status`        | Meaning                                                                                                                    |
| --------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `NOT_STARTED`   | Scheduled, not yet kicked off                                                                                              |
| `STARTED`       | In play (including half-time)                                                                                              |
| `CLOSE_OF_PLAY` | A multi-day cricket Test between days — at stumps, still ongoing. Resumes the next day and stays visible until `FINISHED`. |
| `FINISHED`      | Completed                                                                                                                  |

<Note>
  `CLOSE_OF_PLAY` is treated as live/ongoing alongside `STARTED`: matches in this state appear in [`/leagues/active`](/api/leagues), [`/matches/active`](/api/matches), and the per-sport [`/matches/live`](/api/matches) feed, and `CLOSE_OF_PLAY` is a valid value for the `status=` filter on `/matches`.
</Note>

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

## Example

```json theme={null}
{
  "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"
}
```
