Match Summary API Follow
Match Summary API
This API will return both fixtures yet to be played and matches with results in the form of a fixture list. No result information is retrieved, the Result Summary call should be used is results data is needed.
It is primarily used at the start of the season to obtain a list of fixtures and then can be run at intervals thereafter to pick up changes
GET http://play-cricket.com/api/v2/matches.json?&site_id=1234&season=2023&api_token=xxxx
Parameters
api_token : | string | required |
site_id: | Int | required |
division_id : | Int | |
cup_id : | Int | |
team_id: | Int | |
season: | string | |
competition_type: | string (League, Cup or Friendly) | |
from_entry_date: | string (dd/mm/yyyy) | |
end_entry_date: | string (dd/mm/yyyy) | |
include_unpublished string (yes) |
Whilst the season parameter is not required it is highly recommended otherwise all fixtures for all seasons will be retrieved which could run into the 1000s.
Further filtering by division_id , cup_id or by a team_id can restrict the fixtures to particular divisions cups and teams. Competition types can restrict the fixtures retrieves to cup or league (divisional) fixtures on a competition site with Friendly also being available on a club site.
The from_entry_date and end_entry_date relate to the last_updated date of the fixture. This is the date the fixture result or scorecard last changed, if a results or scorecard is added this date changes. These dates do not allow a time parameter and default to 00:00:00 on the date specified. Therefore to obtain matches changed on 27/11/2023 set from_entry_date as 27/11/2023 and end_entry_date as 28/11/2023
Unpublished matches are fixtures that have been created in league sites but not yet been published in the front end or made available in the club sites. The majority of users will not require these records and by default they are not returned.
Play Cricket will respond with a list of matches meeting the criteria.
For instance, for a call
Returns
{
"matches": [
{
"id": 5681166,
"status": "New",
"published": "Yes",
"last_updated": "11/04/2023",
"league_name": "",
"league_id": "",
"competition_name": "",
"competition_id": "",
"competition_type": "Friendly",
"match_type": "Limited Overs",
"game_type": "Standard",
"season": "2023",
"match_date": "08/04/2023",
"match_time": "13:00",
"ground_name": "Tranter's Field",
"ground_id": "6065",
"ground_latitude": "52.313748",
"ground_longitude": "-1.4538062",
"home_club_name": "Hunningham CC",
"home_team_name": "Friendly XI",
"home_team_id": "175868",
"home_club_id": "3540",
"away_club_name": "Fillongley CC",
"away_team_name": "Friendly XI",
"away_team_id": "154879",
"away_club_id": "2720",
"umpire_1_name": "",
"umpire_1_id": "",
"umpire_2_name": "",
"umpire_2_id": "",
"umpire_3_name": "",
"umpire_3_id": "",
"referee_name": "",
"referee_id": "",
"scorer_1_name": "",
"scorer_1_id": "",
"scorer_2_name": "",
"scorer_2_id": ""
},
{
"id": 5580570,
"status": "New",
"published": "Yes",
"last_updated": "16/04/2023",
"league_name": "",
"league_id": "",
"competition_name": "",
"competition_id": "",
"competition_type": "Friendly",
"match_type": "Limited Overs",
"game_type": "Standard",
"season": "2023",
"match_date": "16/04/2023",
"match_time": "13:00",
"ground_name": "",
"ground_id": "",
"ground_latitude": "",
"ground_longitude": "",
"home_club_name": "Hunningham CC",
"home_team_name": "Friendly XI",
"home_team_id": "175868",
"home_club_id": "3540",
"away_club_name": "Barby CC, Northants",
"away_team_name": "Friendly XI",
"away_team_id": "39722",
"away_club_id": "912",
"umpire_1_name": "",
"umpire_1_id": "",
"umpire_2_name": "",
"umpire_2_id": "",
"umpire_3_name": "",
"umpire_3_id": "",
"referee_name": "",
"referee_id": "",
"scorer_1_name": "",
"scorer_1_id": "",
"scorer_2_name": "",
"scorer_2_id": ""
},
{
"id": 5948931,
"status": "New",
"published": "Yes",
"last_updated": "04/04/2023",
"league_name": "",
"league_id": "",
"competition_name": "",
"competition_id": "",
"competition_type": "Friendly",
"match_type": "Limited Overs",
"game_type": "Standard",
"season": "2023",
"match_date": "27/07/2023",
"match_time": "10:30",
"ground_name": "Tranter's Field",
"ground_id": "6065",
"ground_latitude": "52.313748",
"ground_longitude": "-1.4538062",
"home_club_name": "Hunningham CC",
"home_team_name": "District U16",
"home_team_id": "245881",
"home_club_id": "3540",
"away_club_name": "Warwickshire CCC",
"away_team_name": "Under 15",
"away_team_id": "266716",
"away_club_id": "17356",
"umpire_1_name": "",
"umpire_1_id": "",
"umpire_2_name": "",
"umpire_2_id": "",
"umpire_3_name": "",
"umpire_3_id": "",
"referee_name": "",
"referee_id": "",
"scorer_1_name": "",
"scorer_1_id": "",
"scorer_2_name": "",
"scorer_2_id": ""
}
]
}
Note this is run on a club site and these are friendly fixtures therefore the competition name, id, league_name and league_id are blank.