type (required): Specifies the type of series to fetch. In this case, it should be set to All, International, Domestic, Leagues, Women.
month (required): Indicates the month for which the series data is requested. For example, 1 represents January.
Expected Response Format
The response will return a JSON object containing the following structure:
title: A string representing the title of the series.
month: A nullable integer indicating the month of the series.
data: An array of objects, where each object contains:
tourName: A string representing the name of the tour.
seriesSearchNameForES: A string for search purposes.
tourID: A string representing the unique identifier for the tour.
teamIDs: An array of strings representing the IDs of the teams involved.
seriesType: A string indicating the type of series (e.g., ODI, Test).
league: A string representing the league name.
matchLevel: A string indicating the level of the match.
seriesStartDate: A string representing the start date of the series.
seriesEndDate: A string representing the end date of the series.
T20count: An integer representing the number of T20 matches.
Odicount: An integer representing the number of ODI matches.
Testcount: An integer representing the number of Test matches.
listA: Nullable field for additional data.
firstClass: Nullable field for first-class match data.
seriesStatus: A string indicating the current status of the series.
priorityFlag: A string indicating if the series has priority.
checkStartDate: A string for date validation.
checkEndDate: A string for date validation.
tournamentImage: Nullable field for the tournament image URL.
hasStatistics: A boolean indicating if statistics are available.
hasPoints: A boolean indicating if points are available.
Additional Notes
Ensure that the type parameter is set to All, International, Domestic, Leagues, Women to receive relevant series data.
The response may include multiple series within the data array, and each series will contain detailed information about the matches and teams involved.
The month parameter helps filter the series based on the specified month, allowing for more targeted queries.
This endpoint is useful for retrieving information about international cricket series scheduled for a given month.
Authorizations
HTTPRequired
Query parameters
typestringOptional
International, All, Domestic, Leagues, Women
Example: International
monthintegerOptional
-999 to 999
Example: 1
Header parameters
x-api-keystringOptionalExample: {API_KEY}
Responses
200
OK
application/json
Responseobject
get
/cricket/api/v3/series
200
OK
Series List (v2)
get
Cricket Series API - Get Live Series
This endpoint retrieves a list of live cricket series based on the specified filter and pagination.
filter (string, required): Specifies the filter for the series. In this case, it is set to all to retrieve all available series. Supported value: all, international, domestic, leagues, women
type (string, required): Indicates the type of series to filter. Here, it is set to live to fetch only live series. Supported Values: live, completed, upcoming
page (integer, required): Denotes the page number for pagination. The default value is 0, which represents the first page.
Response
The response will be in JSON format and will contain an array of series objects. Each object may have the following fields:
tourName (string): The name of the tour.
seriesSearchNameForES (string): The search name for the series in Elasticsearch.
tourID (string): The unique identifier for the tour.
league (string): The league associated with the series.
seriesStartDate (string): The start date of the series.
seriesEndDate (string): The end date of the series.
T20count (integer): The number of T20 matches in the series.
matchLevel (string): The level of matches in the series (e.g., domestic, international).
Odicount (integer): The number of ODI matches in the series.
Testcount (integer or null): The number of Test matches in the series.
seriesStatus (string): The current status of the series.
Summary
This API endpoint is designed to provide users with information about live cricket series, allowing them to filter and paginate through the data effectively.
