# SportXAPI

> SportXAPI Cricket API Documentation & Interactive Reference

- [SportXAPI Cricket Data API](https://docsv2.sportxapi.com/index.md): High-performance, low-latency cricket data API for live scoreboards, ball-by-ball commentary, match statistics, schedules, series, squads, players, and rankings.
- [Getting Started](https://docsv2.sportxapi.com/getting-started.md): Start querying live cricket data with SportXAPI in minutes.
- [Authentication](https://docsv2.sportxapi.com/authentication.md): How to authenticate requests to the SportXAPI Cricket API.
- [Rate Limits & Plans](https://docsv2.sportxapi.com/rate-limits.md): Understanding rate limits, quotas, and scaling on SportXAPI.
- [Errors & Status Codes](https://docsv2.sportxapi.com/errors.md): HTTP status codes and error formats returned by the SportXAPI Cricket API.
- [API Reference Overview](https://docsv2.sportxapi.com/api-reference.md): Comprehensive reference for 54 public cricket endpoints across matches, commentary, fixtures, tournaments, players, rankings, and search.
- [SDKs & Code Examples](https://docsv2.sportxapi.com/sdks.md): Implementation examples in JavaScript / TypeScript and Python for SportXAPI.
- [Webhooks](https://docsv2.sportxapi.com/webhooks.md): Information regarding webhooks and event streaming on SportXAPI.
- [Changelog](https://docsv2.sportxapi.com/changelog.md): Product updates, schema improvements, and releases for SportXAPI.
- [Featured Matches](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/featured-matches.md): Curated list of featured live, upcoming, and recently finished matches.
- [Live Score](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/live-score.md): Realtime score payload for a live match, including overs, run-rate, and phase.
- [Scorecard](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/scorecard.md): Full scoreboard — batting/bowling cards, fall of wickets, partnership view.
- [Live Stream (SSE)](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/live-stream-sse.md): Server-Sent Events stream for live matches. Keeps a heartbeat until the game ends.
- [Commentary (v2)](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/commentary-v2.md): Text commentary page, filterable by innings and over range.
- [Commentary (v3)](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/commentary-v3.md): Versioned commentary endpoint with condensed framing around the same cursor params.
- [Ball-by-Ball](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/ball-by-ball.md): Per-ball sequence for a commentary page.
- [Highlights](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/highlights.md): Highlight events for a match (wickets, milestones).
- [Last 12 Balls](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/last-12-balls.md): Rolling window of the most recent 12 deliveries.
- [Match Details](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/match-details.md): Structured details (venue, toss, officials, squad context).
- [Worm / Graph](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/worm-graph.md): Run progression graph payload for charting run-rate and projection.
- [Win Probability](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/win-probability.md): Modelled winning percentage over time (if available for this match).
- [Head-to-Head](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/head-to-head.md): Recent head-to-head between the two teams.
- [Last Five](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/last-five.md): Last five matches for each side in the fixture.
- [Summary](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/summary.md): Condensed post-match summary (route path is /summery for backwards compatibility).
- [Team Analysis](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/team-analysis.md): Computed matchup analysis context for the fixture.
- [Team Records](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/team-records.md): Historical team records scoped to the fixture.
- [Top Pick](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/top-pick.md): Editorial top picks for the match.
- [Player Records](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/player-records.md): Player head-to-heads and matchup records for the fixture.
- [Venue Profile (Match)](https://docsv2.sportxapi.com/api-reference/live-matches-&-ball-by-ball/venue-profile-match.md): Venue profile anchored to a specific match.
- [Schedule (v2)](https://docsv2.sportxapi.com/api-reference/schedules/schedule-v2.md): Paginated schedule with status/type filters. status=live is served from the live cache when LIVE_CACHE_ONLY is on.
- [Schedule (v3)](https://docsv2.sportxapi.com/api-reference/schedules/schedule-v3.md): Versioned schedule — same shape, alternate versioning contract.
- [Series List](https://docsv2.sportxapi.com/api-reference/series-&-tournaments/series-list.md): Paginated series list. Filter by international/domestic/etc.
- [Series (All)](https://docsv2.sportxapi.com/api-reference/series-&-tournaments/series-all.md): Extended series listing.
- [Series Home](https://docsv2.sportxapi.com/api-reference/series-&-tournaments/series-home.md): Homepage-curated series bucket.
- [Series List (v3)](https://docsv2.sportxapi.com/api-reference/series-&-tournaments/series-list-v3.md): Versioned series list with month windowing.
- [Series Info](https://docsv2.sportxapi.com/api-reference/series-&-tournaments/series-info.md): Metadata for a series.
- [Series Fixtures](https://docsv2.sportxapi.com/api-reference/series-&-tournaments/series-fixtures.md): All matches in a series.
- [Series Squads](https://docsv2.sportxapi.com/api-reference/series-&-tournaments/series-squads.md): Squads declared for the series.
- [Points Table](https://docsv2.sportxapi.com/api-reference/series-&-tournaments/points-table.md): Standings / points table for the series.
- [Series Venues](https://docsv2.sportxapi.com/api-reference/series-&-tournaments/series-venues.md): Venues hosting the series.
- [Favourite Teams](https://docsv2.sportxapi.com/api-reference/teams-&-venues/favourite-teams.md): Editor-curated favourite teams list.
- [Team Info](https://docsv2.sportxapi.com/api-reference/teams-&-venues/team-info.md): Team information card.
- [Team Profile](https://docsv2.sportxapi.com/api-reference/teams-&-venues/team-profile.md): Full team profile.
- [Team Recent Form](https://docsv2.sportxapi.com/api-reference/teams-&-venues/team-recent-form.md): Recent fixtures involving this team.
- [Team Schedule](https://docsv2.sportxapi.com/api-reference/teams-&-venues/team-schedule.md): Fixtures filtered to a single team.
- [Team Statistics](https://docsv2.sportxapi.com/api-reference/teams-&-venues/team-statistics.md): Aggregated statistics for the team.
- [Team Squads](https://docsv2.sportxapi.com/api-reference/teams-&-venues/team-squads.md): Squads linked to this team.
- [Venue Lookup](https://docsv2.sportxapi.com/api-reference/teams-&-venues/venue-lookup.md): Stadium / venue detail lookup.
- [Player Profile](https://docsv2.sportxapi.com/api-reference/players/player-profile.md): Biography, role, and career metadata for a player.
- [Player Recent Matches](https://docsv2.sportxapi.com/api-reference/players/player-recent-matches.md): Recent fixtures for the player.
- [Fantasy Matches](https://docsv2.sportxapi.com/api-reference/players/fantasy-matches.md): Fantasy-relevant matches for the player.
- [Men — Batting/Bowling/All-Rounder (v2)](https://docsv2.sportxapi.com/api-reference/rankings/men-—-battingbowlingall-rounder-v2.md): Mens individual rankings.
- [Women — Individual (v2)](https://docsv2.sportxapi.com/api-reference/rankings/women-—-individual-v2.md): Womens individual rankings.
- [Team Rankings (v2)](https://docsv2.sportxapi.com/api-reference/rankings/team-rankings-v2.md): Team rankings (v2).
- [Men (v3)](https://docsv2.sportxapi.com/api-reference/rankings/men-v3.md): Mens individual rankings — versioned endpoint.
- [Women (v3)](https://docsv2.sportxapi.com/api-reference/rankings/women-v3.md): Womens individual rankings — versioned.
- [Team — Men (v3)](https://docsv2.sportxapi.com/api-reference/rankings/team-—-men-v3.md): Mens team rankings — versioned.
- [Team — Women (v3)](https://docsv2.sportxapi.com/api-reference/rankings/team-—-women-v3.md): Womens team rankings — versioned.
- [News Feed](https://docsv2.sportxapi.com/api-reference/news-&-shorts/news-feed.md): Paginated news feed.
- [Article Details](https://docsv2.sportxapi.com/api-reference/news-&-shorts/article-details.md): Single article payload.
- [Shorts](https://docsv2.sportxapi.com/api-reference/news-&-shorts/shorts.md): Cursor-paginated shorts. Backed by a dedicated short-news provider when SHORT_NEWS_API_KEY is configured.
- [Search — Players](https://docsv2.sportxapi.com/api-reference/search/search-—-players.md): Player search by query string.
- [Search — Teams](https://docsv2.sportxapi.com/api-reference/search/search-—-teams.md): Team search by query string.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.