Links

GET Rounds by Search by Name

Returns all rounds that matches your search query
Base URL
Example Response
Field Description
https://api.sportmonks.com/v3/football/rounds/search/{searchQuery}
{
"data": [
{
"id": 23326,
"sport_id": 1,
"league_id": 271,
"season_id": 1273,
"stage_id": 1086,
"name": "10",
"finished": true,
"is_current": false,
"starting_at": "2005-10-26",
"ending_at": "2005-11-06",
"games_in_current_week": false
},
{
"id": 23349,
"sport_id": 1,
"league_id": 271,
"season_id": 1274,
"stage_id": 1087,
"name": "10",
"finished": true,
"is_current": false,
"starting_at": "2006-10-29",
"ending_at": "2006-11-12",
"games_in_current_week": false
},
{
"id": 23384,
"sport_id": 1,
"league_id": 271,
"season_id": 1275,
"stage_id": 1088,
"name": "10",
"finished": true,
"is_current": false,
"starting_at": "2007-11-04",
"ending_at": "2007-11-25",
"games_in_current_week": false
},
//and more
Field
Description
Type
id
Refers to the unique id of the requested round
integer
sport_id
Refers to the sport id of the requested round
integer
league_id
Refers to the league id of the requested round
integer
season_id
Refers to the season id of the requested round
integer
group_id
Refers to the group id of the requested round
integer
name
Returns the name of the requested round
string
finished
Indicates if the requested round is finished or not
boolean
pending
Indicates if the requested round is finished or not
boolean
is_current
Indicates if the requested round is the current one or not
boolean
starting_at
Returns the starting date of the round
string
ending_at
Returns the ending date of the round
string
Query Parameters
Static Filters
Dynamic Filters
Query Parameters
Required?
Description
api_token
YES Another option is to provide the API token in the header.
Your unique API token. Ex. ?api_token=YOUR_TOKEN
include
NO
Enrich the API with more data by using includes
select
NO
Select specific fields on the base entity
filters
NO
Filter the API response on multiple related entities. There are static filters and dynamic filters.
Please find the possibilities in the Static and Dynamic Filter tab.
Static filters are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page.
Static Filters
Available on Entity
Description
Example
N/A
N/A
Not available for this endpoint.
N/A
The dynamic filters are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page.
Using an include? Check their respective filters on their entity page. For example if you use &include=fixtures, you can apply fixture-related filters.
Dynamic Filters
Available on Entity
Description
Examples
leagues
Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.
Filter rounds based on leagues.
&include=league &filters=roundLeagues:leagueIDS
&include=league
&filters=roundLeagues:501
seasons
Check this endpoint for all possibilities.
Filter rounds based on seasons.
&include=season&filters=roundSeasons:seasonIDS
&include=season&filters=roundSeasons:19735
stages
Check this endpoint for all possibilities.
Filter rounds based on stage IDs
&include=stage&filters=roundStages:stageIDS
&include=&filters=roundStages:77457866

Filters

More information on how to use filters can be found on our tutorials on how to filter. If you want more information on which filters to use you can check out the following endpoint:
https://api.sportmonks.com/v3/my/filters/entity?api_token=YOUR_TOKEN

Pagination

YES

Include depth

You can use a total of 4 nested includes on this endpoint

Include options

Get an overview and explanation of all the fields returned in the API response. The related entities for the rounds endpoints are:

Postman

We also offer detailed postman documentation with examples and a complete up-to-date version of all our endpoints. Below is a button that lets your fork the collection or import it.
Run in Postman

Code Example

Ruby
Python
PHP
Java
Node.js
Go
require "uri"
require "net/http"
url = URI("https://api.sportmonks.com/v3/football/rounds/search/{searchQuery}?api_token=YOUR_TOKEN")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
response = https.request(request)
puts response.read_body
import http.client
conn = http.client.HTTPSConnection("api.sportmonks.com")
payload = ''
headers = {}
conn.request("GET", "/v3/football/rounds/search/{searchQuery}?api_token=YOUR_TOKEN", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.sportmonks.com/v3/football/rounds/search/{searchQuery}?api_token=YOUR_TOKEN',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
));
$response = curl_exec($curl);
curl_close($curl);
echo $respons
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.sportmonks.com/v3/football/rounds/search/{searchQuery}?api_token=YOUR_TOKEN")
.method("GET", null)
.build();
Response response = client.newCall(request).execute();
var unirest = require('unirest');
var req = unirest('GET', 'https://api.sportmonks.com/v3/football/rounds/search/{searchQuery}?api_token=YOUR_TOKEN')
.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.raw_body);
});
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.sportmonks.com/v3/football/rounds/search/{searchQuery}?api_token=YOUR_TOKEN"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}