Guides
Start typing to search…

Endpoint Definitions

A summary of what each endpoint will return

Matches

  • Get Matches - /v1/matches - get a full list of matches
  • Get Commentary - /v1/matches/(matchId)/commentary - get commentary for a given match
  • Get Current Match - v1/matches/current - get the current live match, if there are no live matches, get the next upcoming match
  • Get Matches Search - v1/matches/search - get a list of matches that fit the search criteria provided
  • Get Match (v1) - v1/matches/(id) - get all details for a single match
  • Get Match (v2) - v2/matches/(ids) - get all details for all match IDs supplied
  • Get Action Events - v1/matches/(id)/events - get all the events for a given match, example events are: start of period, pass, blocked pass, foul, attempted tackle, take on, challenge, ball out of play. View the sample data to get a full list of available action events.
  • Get Player Traits - v1/matches/(id)/player-traits - dictated by the provider, for a given match there are a number of titles awarded to players who made significant actions during a match, these titles are "interceptor", "fortress", "warrior", "orchestrator", "playmaker", "game changer", "dynamo" and "clinical", this will return one player per title.

Teams

  • Get Teams (v1) - v1/teams - get a list of teams
  • Get Teams (v2) - v2/teams/(ids) - get a list of teams, restricted to the provided team IDs
  • Get Team Stats - v1/teams/(id)/stats - get season stats for a given team
  • Get Players - v1/teams/(teamId)/players - get a list of players for a given team, will include transferred out players

Players

  • Get Player - v1/players/(playerId) - get information about a player

Tables

  • Get Tables (v1) - v1/tables/(compId) - get current table for a given competition/tournament/league
  • Get Tables (v2) - v2/tables/(compIds) - get current table for a list of competitions/tournaments/leagues

Form

  • Get Team Form (v1) - v1/form/(teamId) - get the form of the given team, showing their performance in the last X matches
  • Get Team Form (v2) - v2/form/(teamIds) - get the form for 2 teams, showing their performance in the last X matches between each other

Head to Head

  • Get Head to Head (v1) - v1/headtohead - Compare 2 teams by retrieving every match they have played against each other based on filters passed in

Updated 24 days ago