Skip to content

get_schedule

2 creditsBasic lookupPOST /v1/get_schedule

Data refreshed · changelog

Upcoming and live matches in every competition, with both sides' ratings

Use it when you want what is being played in the next days in any competition, with both sides' ratings.

Parameters

competitionstringoptional
Competition key, e.g. bbl, ipl, test, t20i.
team_idstringoptional
Team id from list_teams.
daysintegeroptional
Days ahead (default 7).
genderenum: male | femaleoptional
include_livebooleanoptional
Include matches in progress (default true).
leagueenum: cricket | test | odi | t20i | ipl | bbl | psl | cpl | blast | hundred | sa20 | ilt20 | county | wbbl | wpl | hundred_womenoptional
League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.

Notes

  • Over MCP, ask for it in plain English and the client calls get_schedule itself. Point any MCP client at https://mcp.yorkerapi.com/mcp?key=YOUR_API_KEY.
  • Each call costs 2 credits, taken before it runs and refunded if the server errors.
  • Not the call you need? Find the right call by what you are trying to answer.

Request

curl -X POST https://mcp.yorkerapi.com/v1/get_schedule \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
  "days": 3
}'

Response

json
{
  "days": 3,
  "matches": [
    {
      "match_id": "1546586",
      "competition": "ranji_trophy",
      "league_name": "Ranji Trophy",
      "match_type": "Test",
      "gender": "male",
      "starts_at": "2026-11-02 03:00:00+00",
      "ends_at": "2026-11-06 23:59:00+00",
      "state": "in",
      "status_detail": "Karnataka lead by 361 runs",
      "description": "Elite, Group B, Ranji Trophy at Guwahati, Nov 2-5 2026",
      "team1": "Assam",
      "team1_id": "assam",
      "team2": "Karnataka",
      "team2_id": "karnataka",
      "venue": "Barsapara Cricket Stadium, Guwahati",
      "city": "Guwahati",
      "country": "India",
      "team1_rating": null,
      "team2_rating": null,
      "favourite": null
    },
    {
      "match_id": "1546598",
      "competition": "ranji_trophy",
      "league_name": "Ranji Trophy",
      "match_type": "Test",
      "gender": "male",
      "starts_at": "2026-11-02 03:00:00+00",
      "ends_at": "2026-11-06 23:59:00+00",
      "state": "in",
      "status_detail": "Nagaland lead by 183 runs",
      "description": "Plate Group, Ranji Trophy at Shillong, Nov 2-5 2026",
      "team1": "Meghalaya",
      "team1_id": "meghalaya",
      "team2": "Nagaland",
      "team2_id": "nagaland",
      "venue": "Meghalaya Cricket Association Cricket Ground, Shillong",
      "city": "Shillong",
      "country": "India",
      "team1_rating": null,
      "team2_rating": null,
      "favourite": null
    },
    {
      "match_id": "1546588",
      "competition": "ranji_trophy",
      "league_name": "Ranji Trophy",
      "match_type": "Test",
      "gender": "male",
      "starts_at": "2026-11-02 03:15:00+00",
      "ends_at": "2026-11-06 23:59:00+00",
      "state": "in",
      "status_detail": "Tripura lead by 204 runs",
      "description": "Elite, Group B, Ranji Trophy at Agartala, Nov 2-5 2026",
      "team1": "Tripura",
      "team1_id": "tripura",
      "team2": "Saurashtra",
      "team2_id": "saurashtra",
      "venue": "Maharaja Bir Bikram College Stadium, Agartala",
      "city": "Agartala",
      "country": "India",
      "team1_rating": null,
      "team2_rating": null,
      "favourite": null
    }
  ],
  "count": 59
}

Response fields

daysnumber
matches[]array
List of objects
matches[].match_idstring
matches[].competitionstring
matches[].league_namestring
matches[].match_typestring
matches[].genderstring
matches[].starts_atstring
matches[].ends_atstring
matches[].statestring
matches[].status_detailstring
matches[].descriptionstring
matches[].team1string
matches[].team1_idstring
matches[].team2string
matches[].team2_idstring
matches[].venuestring
matches[].citystring
matches[].countrystring
matches[].team1_ratingnull
matches[].team2_ratingnull
matches[].favouritenull
countnumber

Related endpoints

Try it

500 free credits every month: 250 calls to get_schedule, and no card.