CRICSTARS / DEVELOPER PLATFORM / API V1

Cricket intelligence.
Built to integrate.

From match scoring to player performance and tournament calculations, integrate 16 cricket calculator APIs using predictable JSON requests. Explore the contract, inspect parameters and test endpoints directly.

16 Calculator endpoints
JSON Request format
v1 Public API
01 / GETTING STARTED

A simpler way to build cricket products.

Send a POST request to the relevant endpoint using Content-Type: application/json. Calculator endpoints currently require no API key. Validate all inputs before sending them.

Request limits 10 requests per 10 seconds and 30 requests per 60 seconds per client IP, shared across the protected API routes.
Payload size JSON request bodies are limited to 8,192 bytes. Invalid media types and unsupported methods are rejected.
Cricket overs notation Write 17 overs and 3 balls as the JSON string "17.3", not a decimal number.
Competition rules Simplified calculations, particularly net run rate and qualification projections, may not reflect every tournament-specific adjustment.

Common statuses: 200 success · 400 invalid input · 405 method not allowed · 413 payload too large · 415 unsupported content type · 429 rate limited · 502/503 service unavailable. Honour Retry-After when supplied.

API REFERENCE

Scoring & match

POST

Calculate required run rate

/api/v1/cricket/required-run-rate
Details +

Supply exactly one of oversUsed or ballsUsed. Current runs must be below target; legal deliveries must remain. JSON request body limit: 8192 bytes. Shared rate limiting: 10 requests/10s, 30 requests/60s per client IP.

Request parameters

Parameter Type Details
target * integer
totalOvers * number
currentRuns * integer
wicketsDown * integer
oversUsed string Cricket overs notation; 17.3 = 17 overs and 3 legal balls. Must be a JSON string. The numeric range is additionally validated by the service.
ballsUsed integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Calculate net run rate

/api/v1/cricket/net-run-rate
Details +

Simplified NRR only, without all-out adjustments. Supply both overs fields OR both balls fields; not both modes. JSON request body limit: 8192 bytes. Shared rate limiting: 10 requests/10s, 30 requests/60s per client IP.

Request parameters

Parameter Type Details
runsScored * integer
runsConceded * integer
oversFaced string Cricket overs notation; 17.3 = 17 overs and 3 legal balls. Must be a JSON string. The numeric range is additionally validated by the service.
oversBowled string Cricket overs notation; 17.3 = 17 overs and 3 legal balls. Must be a JSON string. The numeric range is additionally validated by the service.
ballsFaced integer
ballsBowled integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Calculate overs and balls converter

/api/v1/cricket/overs-balls
Details +

Exactly one of overs or balls is required. Cricket notation 17.3 means 17 overs and 3 deliveries, not 17.3 decimal overs. JSON request body limit: 8192 bytes. Shared rate limiting: 10 requests/10s, 30 requests/60s per client IP.

Request parameters

Parameter Type Details
overs string Cricket overs notation; 17.3 = 17 overs and 3 legal balls. Must be a JSON string. The numeric range is additionally validated by the service.
balls integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Calculate follow-on eligibility

/api/v1/cricket/follow-on
Details +

Eligibility is advisory. The team leading may choose whether to enforce the follow-on. JSON request body limit: 8192 bytes. Shared rate limiting: 10 requests/10s, 30 requests/60s per client IP.

Request parameters

Parameter Type Details
firstScore * integer
secondScore * integer
days * integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Calculate run rate

/api/v1/cricket/run-rate
Details +

Exactly one of overs or balls must be provided; must represent positive balls. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
runs * integer
overs string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
balls integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Project innings score

/api/v1/cricket/projected-score
Details +

oversCompleted must be positive and less than totalOvers; recentRuns and recentOvers must be supplied together. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
currentRuns * number
oversCompleted * string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
totalOvers * number
wicketsLost integer
recentRuns number
recentOvers string Cricket notation as a string: 17.3 means 17 overs and 3 balls.

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

API REFERENCE

Batting

POST

Calculate batting average

/api/v1/cricket/batting-average
Details +

Dismissals = innings minus not outs. When dismissals are zero the battingAverage response is null. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
runs * integer
innings * integer
notOuts integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Calculate batting strike rate

/api/v1/cricket/strike-rate
Details +

Exactly one of overs or balls must be provided; this is a batting strike rate calculated per 100 deliveries. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
runs * integer
overs string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
balls integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Calculate batting partnership contribution

/api/v1/cricket/partnership
Details +

Optional legalBalls overrides the sum of batter balls only when greater than zero. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
aRuns * integer
aBalls * integer
bRuns * integer
bBalls * integer
extras integer
legalBalls integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

API REFERENCE

Bowling

POST

Calculate bowling average

/api/v1/cricket/bowling-average
Details +

Bowling average returns null if wickets equals zero. JSON request body limit: 8192 bytes. Shared rate limiting: 10 requests/10s, 30 requests/60s per client IP.

Request parameters

Parameter Type Details
runsConceded * integer
wickets * integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Calculate bowling strike rate

/api/v1/cricket/bowling-strike-rate
Details +

Requires positive overs and wickets. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
overs * string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
wickets * integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Calculate economy rate

/api/v1/cricket/economy-rate
Details +

Exactly one of overs or balls must be provided; positive delivery count required. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
runsConceded * integer
overs string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
balls integer

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Calculate bowling over rate

/api/v1/cricket/over-rate
Details +

targetOvers and totalMinutes are optional, used together for a projected finish rate. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
oversBowled * string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
minutesElapsed * number
requiredRate * number
targetOvers number
totalMinutes number

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

API REFERENCE

Tournament & analysis

POST

Project simplified NRR scenario

/api/v1/cricket/nrr-scenario
Details +

For mode bat requires batScore,batOvers,oppScoreBat,oppOversBat; for chase requires oppScoreChase,oppOversChase,chaseScore,chaseOvers. Simplified NRR without all-out adjustment. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
mode * enum
Allowed: bat, chase
forRuns * number
forOvers * string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
againstRuns * number
againstOvers * string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
rivalNrr * number
matchOvers * number
batScore integer
batOvers string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
oppScoreBat number
oppOversBat string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
oppScoreChase number
oppOversChase string Cricket notation as a string: 17.3 means 17 overs and 3 balls.
chaseScore number
chaseOvers string Cricket notation as a string: 17.3 means 17 overs and 3 balls.

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Rank a cricket points table

/api/v1/cricket/points-table
Details +

Ranking is by points, net run rate, wins and team name. This does not verify team played-match totals. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
teams * array<object>
winPts number
tiePts number
nrPts number

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

POST

Evaluate projected qualification cut-off

/api/v1/cricket/qualification
Details +

Models a single rival points cut-off scenario, not guaranteed qualification; rivalWins and rivalNR cannot exceed remaining matches in total. All calculations are provisional where competition-specific rules apply. Cricket overs inputs use string notation. JSON body limit and shared client-IP rate limits are enforced by the existing calculator gateway.

Request parameters

Parameter Type Details
yourPoints * number
yourRemaining * integer
yourNrr * number
rivalPoints * number
rivalRemaining * integer
rivalWins integer
rivalNR integer
rivalNrr * number
winPts number
nrPts number

* Required field. Other restrictions may apply; see the full OpenAPI schema.

Example request

Editable starting payload based on the OpenAPI schema. Check values before sending.

Requests use the live public endpoint. Do not send confidential information. The existing API rate limits apply.

Response will appear here after a request.

Documented HTTP statuses: 200 · 400 · 405 · 413 · 415 · 429 · 502 · 503

BUILD WITH CRICSTARS

One cricket platform. More to build.

The calculator API is part of the wider Cricstars developer ecosystem, alongside tournament planning, coaching content and cricket news.