.png%3Falt%3Dmedia%26token%3D21947f78-6585-4468-bf7f-df26530c8a43)
.png%3Falt%3Dmedia%26token%3D21947f78-6585-4468-bf7f-df26530c8a43)
GET Stages by Search by Name
Returns all stages that matches your search query
Base URL
Example Response
Field Description
https://api.sportmonks.com/v3/football/stages/search/{searchQuery}
{
"data": [
{
"id": 1086,
"sport_id": 1,
"league_id": 271,
"season_id": 1273,
"type_id": 223,
"name": "Regular Season",
"sort_order": 1,
"finished": true,
"is_current": false,
"starting_at": "2005-07-19",
"ending_at": "2006-05-14",
"games_in_current_week": false
},
{
"id": 1087,
"sport_id": 1,
"league_id": 271,
"season_id": 1274,
"type_id": 223,
"name": "Regular Season",
"sort_order": 1,
"finished": true,
"is_current": false,
"starting_at": "2006-07-19",
"ending_at": "2007-05-27",
"games_in_current_week": false
},
Field | Description | Type |
|---|---|---|
id | Refers to the unique id of the stage | integer |
sport_id | Refers to the sport of the stage | integer |
league_id | Refers to the league related to the stage | integer |
season_id | Refers to the season related to the stage | integer |
type_id | Indicates what the stage type is | integer |
name | Returns the name of the stage | string |
sort_order | Returns the order of the stage | integer |
finished | Indicates if the stage is finished or not | boolean |
pending | Indicates if the stage is pending or not | boolean |
is_current | Indicates if the stage is the current stage or not | boolean |
starting_at | The starting date of the stage | string |
ending_at | The end date of the stage | string |
Query Parameters
Static Filters
Dynamic Filters
Name | 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 response with more data by using includes. Ex. &include=participants;events |
select | NO | |
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 |
|---|---|---|---|
Types | Filter the stages on a selection of type IDs separated by a comma. | &include=type&filters=stageTypes:typeIDS
&include=type&filters=stageTypes:223 | |
ParticipantSearch | Filter the fixtures of certain participants | &include=fixtures&filters=ParticipantSearch:search_query &include=fixtures&filters=ParticipantSearch:Celtic | |
Fixture statistics | Include the fixtures and only filter on the statistics you're interested in. | &include=fixtures&filters=fixturestatisticTypes:typeIDS &include=fixtures&filters=fixturestatisticTypes:84 |
https://api.sportmonks.com/v3/my/filters/entity?api_token=YOUR_TOKEN
YES
You can use a total of
4 nested includes on this endpointGet an overview and explanation of all the fields returned in the API response. The related entities for the stages endpoints are:
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.
Ruby
Python
PHP
Java
Node.js
Go
require "uri"
require "net/http"
url = URI("https://api.sportmonks.com/v3/football/stages/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/stages/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/stages/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/stages/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/stages/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/stages/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))
}
Last modified 18d ago