# Series Lists API ## Series List (v3) > \## API Endpoint: Get Cricket Series\ > \ > \### Request Method\ > \ > \`GET\`\ > \ > \### Endpoint\ > \ > \` > \ > \### Query Parameters\ > \ > \- \*\*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. ```json {"openapi":"3.0.0","info":{"title":"CRICKET API V3","version":"1.0.0"},"tags":[{"name":"Series Lists API"}],"servers":[{"url":"https://apiv3.sportsapi360.com"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"x-api-key"}}},"paths":{"/cricket/api/v3/series":{"get":{"tags":["Series Lists API"],"summary":"Series List (v3)","description":"## API Endpoint: Get Cricket Series\n\n### Request Method\n\n`GET`\n\n### Endpoint\n\n`https://apiv3.sportsapi360.com/cricket/api/v3/series`\n\n### Query Parameters\n\n- **type** (required): Specifies the type of series to fetch. In this case, it should be set to **All, International, Domestic, Leagues, Women**.\n \n- **month** (required): Indicates the month for which the series data is requested. For example, `1` represents January.\n \n\n### Expected Response Format\n\nThe response will return a JSON object containing the following structure:\n\n- **title**: A string representing the title of the series.\n \n- **month**: A nullable integer indicating the month of the series.\n \n- **data**: An array of objects, where each object contains:\n \n - **tourName**: A string representing the name of the tour.\n \n - **seriesSearchNameForES**: A string for search purposes.\n \n - **tourID**: A string representing the unique identifier for the tour.\n \n - **teamIDs**: An array of strings representing the IDs of the teams involved.\n \n - **seriesType**: A string indicating the type of series (e.g., ODI, Test).\n \n - **league**: A string representing the league name.\n \n - **matchLevel**: A string indicating the level of the match.\n \n - **seriesStartDate**: A string representing the start date of the series.\n \n - **seriesEndDate**: A string representing the end date of the series.\n \n - **T20count**: An integer representing the number of T20 matches.\n \n - **Odicount**: An integer representing the number of ODI matches.\n \n - **Testcount**: An integer representing the number of Test matches.\n \n - **listA**: Nullable field for additional data.\n \n - **firstClass**: Nullable field for first-class match data.\n \n - **seriesStatus**: A string indicating the current status of the series.\n \n - **priorityFlag**: A string indicating if the series has priority.\n \n - **checkStartDate**: A string for date validation.\n \n - **checkEndDate**: A string for date validation.\n \n - **tournamentImage**: Nullable field for the tournament image URL.\n \n - **hasStatistics**: A boolean indicating if statistics are available.\n \n - **hasPoints**: A boolean indicating if points are available.\n \n\n### Additional Notes\n\n- Ensure that the `type` parameter is set to **All, International, Domestic, Leagues, Women** to receive relevant series data.\n \n- The response may include multiple series within the `data` array, and each series will contain detailed information about the matches and teams involved.\n \n- The `month` parameter helps filter the series based on the specified month, allowing for more targeted queries.\n \n\nThis endpoint is useful for retrieving information about international cricket series scheduled for a given month.","parameters":[{"name":"x-api-key","in":"header","schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"},"description":"International, All, Domestic, Leagues, Women"},{"name":"month","in":"query","schema":{"type":"integer"},"description":"-999 to 999"}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}}}}}} ``` ## Series List (v2) > \# Cricket Series API - Get Live Series\ > \ > This endpoint retrieves a list of live cricket series based on the specified filter and pagination.\ > \ > \## Request\ > \ > \*\*Method:\*\* \`GET\` \ > \*\*Endpoint:\*\* \` > \ > \### Query Parameters\ > \ > \- \*\*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. ```json {"openapi":"3.0.0","info":{"title":"CRICKET API V3","version":"1.0.0"},"tags":[{"name":"Series Lists API"}],"servers":[{"url":"https://apiv3.sportsapi360.com"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"x-api-key"}}},"paths":{"/cricket/api/v2/series":{"get":{"tags":["Series Lists API"],"summary":"Series List (v2)","description":"# Cricket Series API - Get Live Series\n\nThis endpoint retrieves a list of live cricket series based on the specified filter and pagination.\n\n## Request\n\n**Method:** `GET` \n**Endpoint:** `https://apiv3.sportsapi360.com/cricket/api/v2/series`\n\n### Query Parameters\n\n- **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`**\n \n- **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`**\n \n- **page** (integer, required): Denotes the page number for pagination. The default value is `0`, which represents the first page.\n \n\n## Response\n\nThe response will be in JSON format and will contain an array of series objects. Each object may have the following fields:\n\n- **tourName** (string): The name of the tour.\n \n- **seriesSearchNameForES** (string): The search name for the series in Elasticsearch.\n \n- **tourID** (string): The unique identifier for the tour.\n \n- **league** (string): The league associated with the series.\n \n- **seriesStartDate** (string): The start date of the series.\n \n- **seriesEndDate** (string): The end date of the series.\n \n- **T20count** (integer): The number of T20 matches in the series.\n \n- **matchLevel** (string): The level of matches in the series (e.g., domestic, international).\n \n- **Odicount** (integer): The number of ODI matches in the series.\n \n- **Testcount** (integer or null): The number of Test matches in the series.\n \n- **seriesStatus** (string): The current status of the series.\n \n\n## Summary\n\nThis API endpoint is designed to provide users with information about live cricket series, allowing them to filter and paginate through the data effectively.","parameters":[{"name":"x-api-key","in":"header","schema":{"type":"string"}},{"name":"filter","in":"query","schema":{"type":"string"},"description":"all,international,domestic,leagues,women"},{"name":"type","in":"query","schema":{"type":"string"},"description":"live, completed, upcoming"},{"name":"page","in":"query","schema":{"type":"integer"},"description":"-999 to 999"}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docsv3.sportsapi360.com/cricket-docs/api-collection-cricket/series-lists-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.