Skip to main content

Featured Matches API ★ USED

Source: https://www.cricketapi.com/v5/docs/match-featured-rest-api Refresh: Multiple intervals — varies by match time (see refresh intervals)

Overview

Manually curated list of matches expected to create high demand. Includes live scores, venues, start dates, match status, flags, organising associations, Players of the Match, team scores, player scores, and other essential match data. The match key from this response can be used to access match-related information from other APIs.

Endpoint

GET /v5/cricket/{project_key}/featured-matches-2/

Headers

rs-token: <access_token>

Sample Request (Node.js)

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

Response Structure

{
"status_code": 200,
"data": {
"matches": {
"<match_key>": {
"key": "ipl_2026_t20_01",
"name": "CSK vs MI, 1st Match",
"status": "started",
"format": "t20i",
"start_at": 1711234567,
"teams": {
"a": {
"key": "csk",
"name": "Chennai Super Kings",
"short_name": "CSK",
"logo_url": "https://..."
},
"b": {
"key": "mi",
"name": "Mumbai Indians",
"short_name": "MI",
"logo_url": "https://..."
}
},
"tournament": {
"key": "ipl_2026",
"name": "Indian Premier League 2026",
"short_name": "IPL 2026"
},
"venue": {
"key": "chepauk",
"name": "MA Chidambaram Stadium",
"city": "Chennai",
"country": "India"
},
"score": {
"a": { "runs": 185, "wickets": 4, "overs": 20 },
"b": { "runs": 120, "wickets": 3, "overs": 15.2 }
},
"result": "CSK won by 65 runs",
"winner": { "key": "csk", "name": "Chennai Super Kings" }
}
},
"cache": {
"key": "featured-matches-2",
"expires": 300,
"max_age": 60,
"etag": "abc123"
},
"schema": { "major": 5, "minor": 2 }
}
}

Key Fields

FieldTypeDescription
matchesObjectMap of match_key → match data
keystringUnique match identifier
namestringHuman-readable match name
statusstringMatch status: not_started, started, completed, cancelled
formatstringMatch format: t20i, odi, test, t10
start_atnumberUnix timestamp (seconds)
teams.a / teams.bObjectHome/away team info (key, name, short_name, logo_url)
tournamentObjectTournament info (key, name, short_name)
venueObjectVenue info (key, name, city, country)
score.a / score.bObjectTeam score (runs, wickets, overs)
resultstringResult string
winnerObjectWinning team (key, name)

Cache Object

Every API response includes a cache object:

FieldDescription
cache.keyRecommended cache key
cache.expiresMax seconds to cache the response
cache.max_ageSeconds before checking for updates (< expires)
cache.etagETag for HTTP caching

Hannibal Usage

File: RoanuzDataAdapter.tsgetMatches()

const featuredData = await this.makeRequest('/featured-matches-2/');
if (featuredData?.matches) {
for (const match of Object.values(featuredData.matches)) {
allMatches.push(this.normalizeMatch(match));
}
}

Also used in:

  • healthCheck() — verifies API access
  • getVenueStatistics() — finds completed matches at a venue