Fantasy rules
On each planFree keyIn fullMatch WeekIn fullArchiveIn fullProIn fullAnalyst ProIn fullMCP toolfantasy_rules
Our default fantasy scoring system, by format family (T20, one-day, long form): points for playing, every batting, bowling and fielding item, the milestone and haul bonuses, and the strike-rate and economy bands, with what each rule is in words.
GET
https://api.cricketdatabase.com/v1/fantasy/rulesTry it
Kept in this browser and filled in on every docs page.
Parameters
None: the key alone identifies the request.
Returns
| Field | Type | What it holds |
|---|---|---|
data | object | |
data.version | integer | |
data.families | object | |
data.families.t20 | string | |
data.families.oneday | string | |
data.families.long | string | |
data.rules | object | |
data.rules.t20 | object | |
data.rules.t20.play | integer | |
data.rules.t20.run | integer | |
data.rules.t20.four | integer | |
data.rules.t20.six | integer | |
data.rules.t20.m30 | integer | |
data.rules.t20.m50 | integer | |
data.rules.t20.m100 | integer | |
data.rules.t20.duck | integer | |
data.rules.t20.sr_min | integer | |
data.rules.t20.sr[] | array | 0, 1 |
data.rules.t20.wkt | integer | |
data.rules.t20.lbwb | integer | |
data.rules.t20.haul | object | |
data.rules.t20.maiden | integer | |
data.rules.t20.dot | integer | |
data.rules.t20.ec_min | integer | |
data.rules.t20.ec[] | array | 0, 1 |
data.rules.t20.catch | integer | |
data.rules.t20.catch3 | integer | |
data.rules.t20.stump | integer | |
data.rules.t20.ro_direct | integer | |
data.rules.t20.ro_shared | integer | |
data.rules.oneday | object | |
data.rules.oneday.play | integer | |
data.rules.oneday.run | integer | |
data.rules.oneday.four | integer | |
data.rules.oneday.six | integer | |
data.rules.oneday.m30 | integer | |
data.rules.oneday.m50 | integer | |
data.rules.oneday.m100 | integer | |
data.rules.oneday.duck | integer | |
data.rules.oneday.sr_min | integer | |
data.rules.oneday.sr[] | array | 0, 1 |
data.rules.oneday.wkt | integer | |
data.rules.oneday.lbwb | integer | |
data.rules.oneday.haul | object | |
data.rules.oneday.maiden | integer | |
data.rules.oneday.dot | integer | |
data.rules.oneday.ec_min | integer | |
data.rules.oneday.ec[] | array | 0, 1 |
data.rules.oneday.catch | integer | |
data.rules.oneday.catch3 | integer | |
data.rules.oneday.stump | integer | |
data.rules.oneday.ro_direct | integer | |
data.rules.oneday.ro_shared | integer | |
data.rules.long | object | |
data.rules.long.play | integer | |
data.rules.long.run | integer | |
data.rules.long.four | integer | |
data.rules.long.six | integer | |
data.rules.long.m30 | integer | |
data.rules.long.m50 | integer | |
data.rules.long.m100 | integer | |
data.rules.long.duck | integer | |
data.rules.long.sr_min | integer | |
data.rules.long.sr | array | |
data.rules.long.wkt | integer | |
data.rules.long.lbwb | integer | |
data.rules.long.haul | object | |
data.rules.long.maiden | integer | |
data.rules.long.dot | integer | |
data.rules.long.ec_min | integer | |
data.rules.long.ec | array | |
data.rules.long.catch | integer | |
data.rules.long.catch3 | integer | |
data.rules.long.stump | integer | |
data.rules.long.ro_direct | integer | |
data.rules.long.ro_shared | integer | |
data.what_each_rule_is | object | |
data.custom | string | |
data.counts | string | |
meta | object |
Example answer
A real answer for /v1/fantasy/rules, lists cut to their first two items.
{
"data": {
"version": 1,
"families": {
"t20": "T20 internationals and every T20",
"oneday": "ODIs and one-day (List A) matches",
"long": "Tests and multi-day matches"
},
"rules": {
"t20": {
"play": 4,
"run": 1,
"four": 1,
"six": 2,
"m30": 4,
"m50": 8,
"m100": 16,
"duck": -2,
"sr_min": 10,
"sr": [
[
170,
6
],
[
150,
4
],
"... 5 more"
],
"wkt": 25,
"lbwb": 8,
"haul": {
"5": 16,
"4": 8,
"3": 4
},
"maiden": 12,
"dot": 1,
"ec_min": 12,
"ec": [
[
5,
6
],
[
6,
4
],
"... 5 more"
],
"catch": 8,
"catch3": 4,
"stump": 12,
"ro_direct": 12,
"ro_shared": 6
},
"oneday": {
"play": 4,
"run": 1,
"four": 1,
"six": 2,
"m30": 0,
"m50": 8,
"m100": 16,
"duck": -2,
"sr_min": 20,
"sr": [
[
140,
6
],
[
120,
4
],
"... 5 more"
],
"wkt": 25,
"lbwb": 8,
"haul": {
"5": 8,
"4": 4
},
"maiden": 4,
"dot": 0,
"ec_min": 30,
"ec": [
[
2.5,
6
],
[
3.5,
4
],
"... 5 more"
],
"catch": 8,
"catch3": 4,
"stump": 12,
"ro_direct": 12,
"ro_shared": 6
},
"long": {
"play": 4,
"run": 1,
"four": 1,
"six": 2,
"m30": 0,
"m50": 8,
"m100": 16,
"duck": -2,
"sr_min": 0,
"sr": [],
"wkt": 16,
"lbwb": 8,
"haul": {
"5": 8,
"4": 4
},
"maiden": 0,
"dot": 0,
"ec_min": 0,
"ec": [],
"catch": 8,
"catch3": 4,
"stump": 12,
"ro_direct": 12,
"ro_shared": 6
}
},
"what_each_rule_is": {
"play": "points for being in the eleven",
"run": "a run off the bat",
"four": "a four, on top of its runs",
"six": "a six, on top of its runs",
"m30": "reaching 30 (not added to 50 or 100)",
"m50": "reaching 50 (not added to 100)",
"m100": "reaching 100",
"duck": "out for 0 (not for a bowler)",
"sr_min": "balls faced before the strike rate counts",
"sr": "strike rate bands: [at or above, points]; a bowler takes a bonus but never a penalty",
"wkt": "a wicket",
"lbwb": "a wicket bowled or lbw, on top",
"haul": "wickets in the match: points (only the highest band met)",
"maiden": "a maiden over",
"dot": "a dot ball bowled",
"ec_min": "balls bowled before the economy counts",
"ec": "economy bands: [at or below runs an over, points]",
"catch": "a catch",
"catch3": "3 catches or more in the match, on top",
"stump": "a stumping",
"ro_direct": "a run out made alone",
"ro_shared": "a share in a run out made by two or more"
},
"custom": "Send rules= with a JSON object over the default for the match's family, any of these keys: numbers for the plain ones, [[bound, points], ...] for sr and ec, {\"wickets\": points} for haul. Example: rules={\"wkt\":30,\"catch\":10,\"dot\":0}. Each answer says whether it was scored by the default or by your rules.",
"counts": "Every match's points are kept as the counts they come from (runs, fours, wickets, catches and the rest), so your rules score the same match exactly as ours."
},
"meta": {
"plan": "plus"
}
}
Errors
| Status | Code | When |
|---|---|---|
| 400 | bad_request | A value is not one this parameter takes, or the key was sent in the address |
| 401 | unauthorized | No key, or one that is unknown or revoked |
| 422 | unknown_parameter | A parameter this endpoint does not take |
| 429 | rate_limited | Too fast: wait for Retry-After |
| 429 | quota_exceeded | The day's calls are used: they reset at midnight UTC |