Skip to main content

​
Endpoint reference

MethodRouteAuthPurpose
GET/matchesUserList matches with filters
GET/matches/liveUserAll currently live matches
POST/user/follow/matchUserFollow a match
PATCH/user/follow/match/:id/teamUserChange supported team
DELETE/user/follow/match/:idUserUnfollow a match
GET/admin/sportmonks/fixturesAdminFetch fixtures from SportMonks
POST/admin/cache/clearAdminClear cached match data
GET/admin/cache/statsAdminView cache statistics

​
List matches

​
GET /matches User

List matches with optional filters. Returns paginated results.
​
league
string
Filter by league ID.
​
status
string
Filter by match status. Values: upcoming, live, completed.
​
from
string
ISO 8601 date string. Only return matches starting after this date.
​
to
string
ISO 8601 date string. Only return matches starting before this date.
GET /matches?league=bbl&status=live&from=2026-01-01&to=2026-03-31

​
GET /matches/live User

Returns all currently live matches across all leagues. No query parameters. 
{
  "matches": [
    {
      "id": "match-001",
      "status": "live",
      "league": "bbl",
      "score": { ... }
    }
  ]
}

​
Match following

These endpoints manage which matches a user follows. Following a match enables push notifications and Live Activity updates.
See the Match following business flow for the full end-to-end journey.

​
POST /user/follow/match User

Follow a match.
​
matchId
string
required
The match to follow.
​
teamId
string
Optional. The team the user supports in this match. Used to personalize notifications.

​
PATCH /user/follow/match/:id/team User

Change the supported team for a match the user is already following.
​
id
string
required
The followed match ID.
​
teamId
string
required
The new team to support.

​
DELETE /user/follow/match/:id User

Unfollow a match. Stops push notifications and Live Activity updates.
​
id
string
required
The followed match ID.

​
Admin match data

​
GET /admin/sportmonks/fixtures Admin

Fetch fixtures directly from the SportMonks API. Useful for debugging data discrepancies.

​
POST /admin/cache/clear Admin

Clear cached live match data. Forces the next LiveScoreJob cycle to fetch fresh data from SportMonks.
​
matchId
string
Clear cache for a specific match. Omit to clear all cached data.

​
GET /admin/cache/stats Admin

View cache hit/miss statistics and memory usage.