Cricket Database
0 of 50 calls today
Get a free API key Sign in Dashboard Upgrade

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.

GEThttps://api.cricketdatabase.com/v1/fantasy/rules

Try it

Kept in this browser and filled in on every docs page.

Press Run to call the API with your key. The answer appears here.

    

Parameters

None: the key alone identifies the request.

Returns

FieldTypeWhat it holds
dataobject
data.versioninteger
data.familiesobject
data.families.t20string
data.families.onedaystring
data.families.longstring
data.rulesobject
data.rules.t20object
data.rules.t20.playinteger
data.rules.t20.runinteger
data.rules.t20.fourinteger
data.rules.t20.sixinteger
data.rules.t20.m30integer
data.rules.t20.m50integer
data.rules.t20.m100integer
data.rules.t20.duckinteger
data.rules.t20.sr_mininteger
data.rules.t20.sr[]array0, 1
data.rules.t20.wktinteger
data.rules.t20.lbwbinteger
data.rules.t20.haulobject
data.rules.t20.maideninteger
data.rules.t20.dotinteger
data.rules.t20.ec_mininteger
data.rules.t20.ec[]array0, 1
data.rules.t20.catchinteger
data.rules.t20.catch3integer
data.rules.t20.stumpinteger
data.rules.t20.ro_directinteger
data.rules.t20.ro_sharedinteger
data.rules.onedayobject
data.rules.oneday.playinteger
data.rules.oneday.runinteger
data.rules.oneday.fourinteger
data.rules.oneday.sixinteger
data.rules.oneday.m30integer
data.rules.oneday.m50integer
data.rules.oneday.m100integer
data.rules.oneday.duckinteger
data.rules.oneday.sr_mininteger
data.rules.oneday.sr[]array0, 1
data.rules.oneday.wktinteger
data.rules.oneday.lbwbinteger
data.rules.oneday.haulobject
data.rules.oneday.maideninteger
data.rules.oneday.dotinteger
data.rules.oneday.ec_mininteger
data.rules.oneday.ec[]array0, 1
data.rules.oneday.catchinteger
data.rules.oneday.catch3integer
data.rules.oneday.stumpinteger
data.rules.oneday.ro_directinteger
data.rules.oneday.ro_sharedinteger
data.rules.longobject
data.rules.long.playinteger
data.rules.long.runinteger
data.rules.long.fourinteger
data.rules.long.sixinteger
data.rules.long.m30integer
data.rules.long.m50integer
data.rules.long.m100integer
data.rules.long.duckinteger
data.rules.long.sr_mininteger
data.rules.long.srarray
data.rules.long.wktinteger
data.rules.long.lbwbinteger
data.rules.long.haulobject
data.rules.long.maideninteger
data.rules.long.dotinteger
data.rules.long.ec_mininteger
data.rules.long.ecarray
data.rules.long.catchinteger
data.rules.long.catch3integer
data.rules.long.stumpinteger
data.rules.long.ro_directinteger
data.rules.long.ro_sharedinteger
data.what_each_rule_isobject
data.customstring
data.countsstring
metaobject

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

StatusCodeWhen
400bad_requestA value is not one this parameter takes, or the key was sent in the address
401unauthorizedNo key, or one that is unknown or revoked
422unknown_parameterA parameter this endpoint does not take
429rate_limitedToo fast: wait for Retry-After
429quota_exceededThe day's calls are used: they reset at midnight UTC