DEVELOPER DOCUMENTATION

Tenant Integration Guide

Twenty-nine cricket endpoints across live scores, scorecards, playing XI, series tables, player profiles, and match predictions — secured behind one SHA-256 hashed PitchCore key.

API Quickstart

Authenticate all requests by including your key in the X-Api-Key HTTP header.

# Fetch active live cricket fixtures with hot-live cache
curl -s -X GET "https://data.getcricketapi.com/v1/liveMatches" \
  -H "X-Api-Key: $YOUR_PITCHCORE_KEY" \
  -H "Accept: application/json"

# Fetch in-play match momentum prediction (matchId from /v1/liveMatches)
curl -s -X GET "https://data.getcricketapi.com/v1/predict/match?matchId=$MATCH_ID" \
  -H "X-Api-Key: $YOUR_PITCHCORE_KEY"

Download OpenAPI Specification (.yaml) →Launch Interactive Model Sandbox Request Enterprise Route Scopes

Gateway HTTP Status Codes

Standard error envelopes returned by the edge gateway.

Status Code	Error Code	Description & Action
`200 OK`	`success`	Request served successfully from Redis hot-cache or origin feed.
`401 Unauthorized`	`key_missing / invalid`	Missing or unrecognized `X-Api-Key` header. Verify your token in the Portal.
`403 Forbidden`	`scope_forbidden`	Your plan does not include this route scope (e.g. playing XI on Starter). Upgrade on Plans.
`429 Too Many Requests`	`rate_limit_exceeded`	Per-second RPS or monthly quota ceiling reached. Back off with exponential jitter.
`503 Unavailable`	`origin_timeout`	Upstream provider temporary timeout. Gateway will serve stale cache when available.

Available Route Groups

Our 29 endpoints are grouped logically into core scoreboards, match centres, series tracking, and content feeds.

All plans

Live scores

Innings score, CRR, last balls, toss, and ball-by-ball commentary.

CRR
Last balls
Toss
Commentary

/v1/liveMatches

All plans

Scorecard

Batting, bowling, extras, partnerships, and fall of wickets.

Batting
Bowling
Extras
Partnership

/v1/match/{id}/scorecard

All plans

Match centre

Playing XI, squads, bench, impact players, over history, and stats.

Playing XI
Impact
Overs
Match stats

/v1/match/{id}/playingXI

All plans

Series

Series list, points table, venues, MOTS, and tracker.

Fixtures
Points
Venues
MOTS

/v1/series

All plans

Players

Player profiles, recent matches, news, and rankings.

Profile
Recent
Batting rank
Team rank

/v1/player/{id}

All plans

Content

Home feed, cricket news, and player news for apps and widgets.

Home feed
News
Player news

/v1/home

Unlock Full Internal Guide

Tenants can unlock the real-time dynamic gateway guide generated by their active subscription scopes.