.png%3Falt%3Dmedia%26token%3D21947f78-6585-4468-bf7f-df26530c8a43)
.png%3Falt%3Dmedia%26token%3D21947f78-6585-4468-bf7f-df26530c8a43)
Comment on page
GET Leagues Search by Name
Returns all the leagues that match your search query.
Base URL
Example Response
Field Description
https://api.sportmonks.com/v3/football/leagues/search/{search_query}
{
"data": [
{
"id": 501,
"sport_id": 1,
"country_id": 1161,
"name": "Premiership",
"active": true,
"short_code": "SCO P",
"image_path": "https://cdn.sportmonks.com/images/soccer/leagues/501.png",
"type": "league",
"sub_type": "domestic",
"last_played_at": "2023-02-25 15:00:00",
"category": 2,
"has_jerseys": false
},
{
"id": 513,
"sport_id": 1,
"country_id": 1161,
"name": "Premiership Play-Offs",
"active": true,
"short_code": "SCO P PO",
"image_path": "https://cdn.sportmonks.com/images/soccer/leagues/1/513.png",
"type": "league",
"sub_type": "play-offs",
"last_played_at": "2021-05-24 20:35:36",
"category": 2,
"has_jerseys": false
}
Field | Description | Type |
|---|---|---|
id | Refers to the unique id of th league | integer |
sport_id | Refers to the sport of the league | integer |
country_id | Refers to the country of the league | integer |
name | The name of the league | string |
active | Indicates if the league is active or inactive | integer |
short_code | The short code of the league | string / null |
image_path | Image path to the league logo | string |
type | Indicates the type of the league | string |
sub_type | Indicates the subtype of the league | string |
last_played_at | The date of when the last fixture was played in the league | string |
category | Indicates the category of the league | integer |
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. |
locale | NO | Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page. |
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 | Example |
|---|---|---|---|
countries | Filter the leagues based on countries. | &include=country&filters=leagueCountries:countryIDs
&include=country&filters=leagueCountries:41 | |
seasons | Statistics (players, team, coaches, referees), Standings, and way more.
Check this endpoint for all possibilities. | Filter statistics, standings and topscorers based on seasons. | &include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs
&include=seasons.statistics&filters=seasonStatisticTypes:52 |
types | Filter the league stages on a selection of type ID's separated by a comma. | &include=stages.type&filters=stageTypes:TypeIDs
&include=stages.type&filters=stageTypes:224 |
https://api.sportmonks.com/v3/my/filters/entity?api_token=YOUR_TOKEN
YES
Parameter | Required | Description | Example |
|---|---|---|---|
order | No | Returns leagues ordered by category ( asc or desc). Defaults to asc | &order=desc |
per_page | No | The amount of results to return per page (max 50.). Defaults to 25. | &per_page=30 |
page | No | You can paginate using the has_more parameter to determine if you can still propagate through the results. | &page=2 |
You can use a total of
2 nested includes on this endpointGet an overview and explanation of all the fields returned in the API response. The related entities for the leagues 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/leagues/search/{search_query}?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", "/api/v3/football/leagues/search/{search_query}?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/api/v3/football/leagues/search/{search_query}?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/api/v3/football/leagues/search/{search_query}?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/api/v3/football/leagues/search/{search_query}?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/api/v3/football/leagues/search/{search_query}?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 3mo ago