List the squads registered in a cricket series by seriesId

View all Cricket Live Scores, Scorecards & Stats API endpoints →

Returns the squad directory of one series, selected with the required numeric seriesId path parameter (the id value from the series list or archived series list endpoints). The source response example documents appIndex (seoTitle, webURL), seriesId, seriesName and a squads array holding two row shapes: header rows with isHeader set to true and a squadType group label such as Test, and squad rows with squadId, squadType (the squad label, which in the example is a team name), teamId and imageId. The response identifies squads only and does not include player rosters. The fields shown are from a source example rather than a live probe, so squad availability depends on coverage for the competition.

API Features

Squad directory for one series A single seriesId returns the squads taking part in that competition, which is the starting point for a tournament roster page.
Format group header rows Rows with isHeader set to true and a squadType such as Test mark a section of the list, so a client can group squads without hard-coding formats.
Squad and team identifiers Every squad row carries a squadId and a teamId, giving one key for squad-level lookups and another for linking to the team.
Squad label and crest image The squadType label on a squad row and its imageId supply display text and a logo reference for each directory entry.
Series context in the payload The response repeats seriesId and seriesName and adds appIndex metadata, so a page can confirm which series it loaded and set a title.

Live API Demo

GET /api/project/cricbuzz-cricket/series-get-squads

Request cost is temporarily unavailable. No price is assumed.

View pricing

API Response (JSON)

{}
curl -X GET 'https://api.opendata-api.com/api/project/cricbuzz-cricket/series-get-squads?key=<API_KEY>&seriesId=3718'
📢
Need Help?
If you encounter API issues or need other API requirements, please contact us.
Contact Us

Use Cases

Frequently asked questions

Does this endpoint return player names?

No. The documented example lists squad rows only, with squadId, squadType, teamId and imageId. Use the squadId in a squad-level player lookup when you need the roster.

What are the isHeader rows in the squads array?

They are section markers with isHeader set to true and a squadType group label, which is Test in the source example. Use them as headings or skip them, because they have no squadId or teamId.

Why does squadType show a team name on squad rows?

In the source example, squad rows use squadType as the squad label, for example a domestic team name, while header rows use it for the format group. Treat it as a display label and rely on squadId and teamId for identity.

Which series does the default seriesId point to?

The default 3718 matches the Plunket Shield 2021-22 series in the source response example. Replace it with an id from the series list or archived series list endpoints.

Are squads available for every series?

Not necessarily. Squad data depends on coverage for the competition and no live probe was recorded here, so handle an empty squads array or a non-200 response as a normal empty state.

Related operations

Guides

View Subscription Plans →