Skip to main content

Match Commentary API ★ USED

Source: https://www.cricketapi.com/v5/docs/ (commentary endpoint)

Overview​

Ball-by-ball text commentary for a match. Returns human-readable commentary entries for each delivery.

Endpoint​

GET /v5/cricket/{project_key}/match/{match_key}/commentary/

Headers​

rs-token: <access_token>

Sample Request (Node.js)​

const response = await axios.get(
  `https://api.sports.roanuz.com/v5/cricket/${projectKey}/match/${matchKey}/commentary/`,
  { headers: { 'rs-token': token } }
);

Response Structure​

Commentary entries contain ball-level descriptions with context.

Hannibal Usage​

File: RoanuzDataAdapter.ts → getCommentary()

async getCommentary(params: GetCommentaryParams): Promise<GetCommentaryResult> {
  const data = await this.makeRequest(`/match/${matchId}/commentary/`);
  let entries = this.normalizeCommentary(matchId, data);
  if (limit) entries = entries.slice(0, limit);
  return { matchId, entries, meta: { provider: 'roanuz', latencyMs } };
}

Commentary is normalized to canonical Commentary[] format.

Default limit: 50 entries.

Note: Commentary text also appears in ball-by-ball data via ball.comment or ball.commentary fields.