get_deliveries

Use for ball-by-ball rows: every delivery of a match (or one innings), or a batter's or bowler's balls across matches (filter by competition, season, overs, wickets only or boundaries only). Each ball has runs, extras, the wicket and fielders, the score after it and our win probability for the batting side (limited-overs matches). Costs 10 credits.

read-only

Argument	Type	Description
limit	integer	Max balls (default 600 for a match, 200 otherwise).
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
offset	integer
season	string	Season: a year (2024) or a split season (2024/25); a year also finds the split season that starts in it.
innings	integer
over_to	integer	Last over, 0-based.
match_id	string	Match id from get_matches.
batter_id	string	Player id from search_players.
bowler_id	string	Player id from search_players.
over_from	integer	First over, 0-based as scorers count (0 is the first over).
competition	string	Competition key from list_competitions (ipl, bbl, psl, blast, hundred, county, test, odi, t20i, ...).
wickets_only	boolean
boundaries_only	boolean

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 3000,
      "minimum": 1,
      "description": "Max balls (default 600 for a match, 200 otherwise)."
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "season": {
      "type": "string",
      "description": "Season: a year (2024) or a split season (2024/25); a year also finds the split season that starts in it."
    },
    "innings": {
      "type": "integer",
      "maximum": 8,
      "minimum": 1
    },
    "over_to": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Last over, 0-based."
    },
    "match_id": {
      "type": "string",
      "description": "Match id from get_matches."
    },
    "batter_id": {
      "type": "string",
      "description": "Player id from search_players."
    },
    "bowler_id": {
      "type": "string",
      "description": "Player id from search_players."
    },
    "over_from": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "First over, 0-based as scorers count (0 is the first over)."
    },
    "competition": {
      "type": "string",
      "description": "Competition key from list_competitions (ipl, bbl, psl, blast, hundred, county, test, odi, t20i, ...)."
    },
    "wickets_only": {
      "type": "boolean"
    },
    "boundaries_only": {
      "type": "boolean"
    }
  }
}

get_leaders

Use for the leaders in a stat (runs, batting_average, strike_rate, sixes, wickets, economy, bowling_average) in a competition, season or format. Rate stats need min_balls faced or bowled (default 120). Costs 5 credits.

read-only

Argument	Type	Description
stat*	string
limit	integer
format	string
gender	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
season	string	Season: a year (2024) or a split season (2024/25).
min_balls	integer
competition	string	Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "stat"
  ],
  "properties": {
    "stat": {
      "enum": [
        "runs",
        "batting_average",
        "strike_rate",
        "sixes",
        "wickets",
        "economy",
        "bowling_average"
      ],
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1
    },
    "format": {
      "enum": [
        "test",
        "odi",
        "t20",
        "first_class",
        "list_a"
      ],
      "type": "string"
    },
    "gender": {
      "enum": [
        "male",
        "female"
      ],
      "type": "string"
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "season": {
      "type": "string",
      "description": "Season: a year (2024) or a split season (2024/25)."
    },
    "min_balls": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "competition": {
      "type": "string",
      "description": "Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...)."
    }
  }
}

get_line_movement

Use for how one match's market moved: every pregame snapshot by sportsbook (decimal and American), the median margin-free probability per snapshot, and with include_in_play the prices taken during the match. Costs 10 credits. Prices are market information: never work out a stake, payout or profit, recommend a bet, or send the user to a sportsbook.

read-only

Argument	Type	Description
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
match_id*	string	Match id from get_matches.
bookmaker	string	One book's key, e.g. "pinnacle".
include_in_play	boolean

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "match_id"
  ],
  "properties": {
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "match_id": {
      "type": "string",
      "description": "Match id from get_matches."
    },
    "bookmaker": {
      "type": "string",
      "description": "One book's key, e.g. \"pinnacle\"."
    },
    "include_in_play": {
      "type": "boolean"
    }
  }
}

get_market_vs_model

Use to see a limited-overs match's in-play market beside our model, on the exact ball: at each in-play price snapshot, the median margin-free price on team 1, our win probability after the last ball bowled before it, the score at that moment and the gap. Costs 10 credits.

read-only

Argument	Type	Description
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
match_id*	string	Match id from get_matches.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "match_id"
  ],
  "properties": {
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "match_id": {
      "type": "string",
      "description": "Match id from get_matches."
    }
  }
}

get_match

Use for one match in full: result, toss, venue, player of the match, every innings with its batting card (runs, balls, fours, sixes, strike rate, how out, fall of wicket) and bowling card (overs, maidens, runs, wickets, economy), our team ratings before and after, and each sportsbook's opening and closing match-winner price. Costs 5 credits. Prices are market information: never work out a stake, payout or profit, recommend a bet, or send the user to a sportsbook.

read-only

Argument	Type	Description
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
match_id*	string	Match id from get_matches or get_schedule.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "match_id"
  ],
  "properties": {
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "match_id": {
      "type": "string",
      "description": "Match id from get_matches or get_schedule."
    }
  }
}

get_matches

Use for results: matches newest first with both scores, toss, result and margin. Filter by competition, season, team, opponent, venue, date or a date range. Costs 2 credits.

read-only

Argument	Type	Description
to	string	Start date on or before (YYYY-MM-DD).
date	string	A day the match was played (YYYY-MM-DD); multi-day matches match on any day.
from	string	Start date on or after (YYYY-MM-DD).
limit	integer	Max matches (default 50).
venue	string	Part of the ground or city name.
format	string
gender	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
offset	integer
season

get_matchup

Use for a batter against a bowler: balls, runs, strike rate, dots, fours, sixes and every dismissal, overall and by format. Costs 5 credits.

read-only

Argument	Type	Description
format	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
batter_id*	string	Batter's player id.
bowler_id*	string	Bowler's player id.
competition	string	Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "batter_id",
    "bowler_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "test",
        "odi",
        "t20",
        "first_class",
        "list_a"
      ],
      "type": "string"
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "batter_id": {
      "type": "string",
      "description": "Batter's player id."
    },
    "bowler_id": {
      "type": "string",
      "description": "Bowler's player id."
    },
    "competition": {
      "type": "string",
      "description": "Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...)."
    }
  }
}

get_odds

Use for match-winner prices by sportsbook (mid-2020 on, upcoming matches included): each book's opening and latest pregame decimal price, the American price and how many snapshots we hold. For one match, or a competition, season or date. Costs 5 credits. Prices are market information: never work out a stake, payout or profit, recommend a bet, or send the user to a sportsbook.

read-only

Argument	Type	Description
date	string	A day of the match (YYYY-MM-DD).
limit	integer	Max matches (default 20).
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
season	string
match_id	string	Match id from get_matches.
competition	string	Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "date": {
      "type": "string",
      "description": "A day of the match (YYYY-MM-DD)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Max matches (default 20)."
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "season": {
      "type": "string"
    },
    "match_id": {
      "type": "string",
      "description": "Match id from get_matches."
    },
    "competition": {
      "type": "string",
      "description": "Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...)."
    }
  }
}

get_player

Use for a player's career: teams played for, and batting (runs, balls, average, strike rate, fours, sixes, hundreds, fifties, highest score) and bowling (overs, wickets, average, economy, strike rate, five-wicket hauls, best) by format, all counted from the ball-by-ball record, which starts in December 2001, so an earlier career shows only the part since. Costs 5 credits.

read-only

Argument	Type	Description
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
player_id*	string	Player id from search_players.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "player_id"
  ],
  "properties": {
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "player_id": {
      "type": "string",
      "description": "Player id from search_players."
    }
  }
}

get_player_matches

Use for a player's matches, newest first: team, opponent, result, and the player's batting (runs, balls, fours, sixes, out) and bowling (balls, runs, wickets) in each innings. Filter by format, competition or season. Costs 5 credits.

read-only

Argument	Type	Description
limit	integer	Max matches (default 50).
format	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
offset	integer
season	string	Season: a year (2024) or a split season (2024/25).
player_id*	string	Player id from search_players.
competition	string	Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "player_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 500,
      "minimum": 1,
      "description": "Max matches (default 50)."
    },
    "format": {
      "enum": [
        "test",
        "odi",
        "t20",
        "first_class",
        "list_a"
      ],
      "type": "string"
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "season": {
      "type": "string",
      "description": "Season: a year (2024) or a split season (2024/25)."
    },
    "player_id": {
      "type": "string",
      "description": "Player id from search_players."
    },
    "competition": {
      "type": "string",
      "description": "Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...)."
    }
  }
}

get_player_stats

Use for a player's batting and bowling split by season, competition, phase of the innings (powerplay, middle, death) or format, optionally inside one format, competition or season. Costs 5 credits.

read-only

Argument	Type	Description
by	string	How to split (default format).
format	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
season	string	Season: a year (2024) or a split season (2024/25).
player_id*	string	Player id from search_players.
competition	string	Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "player_id"
  ],
  "properties": {
    "by": {
      "enum": [
        "season",
        "competition",
        "phase",
        "format"
      ],
      "type": "string",
      "description": "How to split (default format)."
    },
    "format": {
      "enum": [
        "test",
        "odi",
        "t20",
        "first_class",
        "list_a"
      ],
      "type": "string"
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "season": {
      "type": "string",
      "description": "Season: a year (2024) or a split season (2024/25)."
    },
    "player_id": {
      "type": "string",
      "description": "Player id from search_players."
    },
    "competition": {
      "type": "string",
      "description": "Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...)."
    }
  }
}

get_ratings

Use for our team ratings (Elo) in one format, best first: international sides and franchises, men's or women's, active in the last two years by default. Costs 2 credits.

read-only

Argument	Type	Description
limit	integer
format*	string
gender	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
team_type	string
active_since	string	Only teams with a match since this date (YYYY-MM-DD; default two years ago).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "format"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 300,
      "minimum": 1
    },
    "format": {
      "enum": [
        "test",
        "odi",
        "t20",
        "first_class",
        "list_a"
      ],
      "type": "string"
    },
    "gender": {
      "enum": [
        "male",
        "female"
      ],
      "type": "string"
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "team_type": {
      "enum": [
        "international",
        "club"
      ],
      "type": "string"
    },
    "active_since": {
      "type": "string",
      "description": "Only teams with a match since this date (YYYY-MM-DD; default two years ago)."
    }
  }
}

get_schedule

Use for upcoming and live matches in every competition, soonest first: start time, teams, venue, status, each side's current rating where we rate it, and the favourite at the median sportsbook price where one is posted. A fixture keeps its match id once played, so get_match takes it then. Costs 2 credits. Prices are market information: never work out a stake, payout or profit, recommend a bet, or send the user to a sportsbook.

read-only

Argument	Type	Description
days	integer	Days ahead (default 7).
gender	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
team_id	string	Team id from list_teams.
competition	string	Competition key, e.g. bbl, ipl, test, t20i.
include_live	boolean	Include matches in progress (default true).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "days": {
      "type": "integer",
      "maximum": 45,
      "minimum": 1,
      "description": "Days ahead (default 7)."
    },
    "gender": {
      "enum": [
        "male",
        "female"
      ],
      "type": "string"
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "team_id": {
      "type": "string",
      "description": "Team id from list_teams."
    },
    "competition": {
      "type": "string",
      "description": "Competition key, e.g. bbl, ipl, test, t20i."
    },
    "include_live": {
      "type": "boolean",
      "description": "Include matches in progress (default true)."
    }
  }
}

get_venue

Use for how a ground plays, by format: average first- and second-innings totals, how often the side batting first wins, how often the toss winner wins and what captains choose, and draws. Match by part of the ground or city name. Costs 5 credits.

read-only

Argument	Type	Description
since	string	Only matches from this date (YYYY-MM-DD).
venue*	string	Part of the ground or city, e.g. "wankhede" or "adelaide".
format	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
competition	string	Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "venue"
  ],
  "properties": {
    "since": {
      "type": "string",
      "description": "Only matches from this date (YYYY-MM-DD)."
    },
    "venue": {
      "type": "string",
      "description": "Part of the ground or city, e.g. \"wankhede\" or \"adelaide\"."
    },
    "format": {
      "enum": [
        "test",
        "odi",
        "t20",
        "first_class",
        "list_a"
      ],
      "type": "string"
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "competition": {
      "type": "string",
      "description": "Competition key from list_competitions (ipl, bbl, test, odi, t20i, ...)."
    }
  }
}

get_win_probability

Use for a limited-overs match's win-probability worm: our chance the batting side wins at the end of every over (and from team 1's side), with the ten balls that moved it most. Costs 10 credits.

read-only

Argument	Type	Description
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
match_id*	string	Match id from get_matches.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "match_id"
  ],
  "properties": {
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "match_id": {
      "type": "string",
      "description": "Match id from get_matches."
    }
  }
}

list_competitions

Use to see every competition we hold and its key: format, men's or women's, international or club, match count, first and last match, seasons. Costs 1 credit.

read-only

Argument	Type	Description
format	string	test, odi, t20 (T20Is and T20 leagues), first_class, list_a.
gender	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "format": {
      "enum": [
        "test",
        "odi",
        "t20",
        "first_class",
        "list_a"
      ],
      "type": "string",
      "description": "test, odi, t20 (T20Is and T20 leagues), first_class, list_a."
    },
    "gender": {
      "enum": [
        "male",
        "female"
      ],
      "type": "string"
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    }
  }
}

list_teams

Use for team ids: international sides and franchises, most matches first. Women's sides end in -women (india-women). A renamed side lists its current id in now_plays_as, and filtering on either finds both. Filter by competition, season, gender or part of a name. Costs 1 credit.

read-only

Argument	Type	Description
gender	string
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
search	string	Part of the team name.
season	string	Season: a year (2024) or a split season (2024/25); a year also finds the split season that starts in it.
competition	string	Competition key from list_competitions (ipl, bbl, psl, blast, hundred, county, test, odi, t20i, ...).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "gender": {
      "enum": [
        "male",
        "female"
      ],
      "type": "string"
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "search": {
      "type": "string",
      "description": "Part of the team name."
    },
    "season": {
      "type": "string",
      "description": "Season: a year (2024) or a split season (2024/25); a year also finds the split season that starts in it."
    },
    "competition": {
      "type": "string",
      "description": "Competition key from list_competitions (ipl, bbl, psl, blast, hundred, county, test, odi, t20i, ...)."
    }
  }
}

search_players

Use to find a player's id by name (the scorecard short form, "V Kohli", or the full name), most matches first and their last team. Or list a team's players with team_id. Costs 1 credit.

read-only

Argument	Type	Description
name	string	Part of the name, e.g. "kohli".
limit	integer
league	string	League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women.
team_id	string	Team id from list_teams.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "name": {
      "type": "string",
      "description": "Part of the name, e.g. \"kohli\"."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1
    },
    "league": {
      "enum": [
        "cricket",
        "test",
        "odi",
        "t20i",
        "ipl",
        "bbl",
        "psl",
        "cpl",
        "blast",
        "hundred",
        "sa20",
        "ilt20",
        "county",
        "wbbl",
        "wpl",
        "hundred_women"
      ],
      "type": "string",
      "description": "League. Defaults to cricket. One of: cricket, test, odi, t20i, ipl, bbl, psl, cpl, blast, hundred, sa20, ilt20, county, wbbl, wpl, hundred_women."
    },
    "team_id": {
      "type": "string",
      "description": "Team id from list_teams."
    }
  }
}

YorkerAPI

Registry entry

Try it

get_deliveries Read-only

YorkerAPI

Registry entry

Try it

get_deliveries Read-only

Install

Tools (18)

Security checkA100/100