.png%3Falt%3Dmedia%26token%3D21947f78-6585-4468-bf7f-df26530c8a43)
.png%3Falt%3Dmedia%26token%3D21947f78-6585-4468-bf7f-df26530c8a43)
GET Regions by Search
Returns region information that matches your search query.
Base URL
Example Response
Field Description
https://api.sportmonks.com/v3/core/regions/search/{search_query}
{
"data": {
"id": 724,
"country_id": 38,
"name": "Utrecht"
},
Field | Description | Type |
|---|---|---|
id | Refers to the id of the region | integer |
country_id | Refers to the country of the region | integer |
name | Displays the name of the region | string |
Query Parameters
Static Filters
Dynamic Filters
Query Parameters | Required? | Description |
|---|---|---|
api_token | YES | Your unique API token |
include | NO | Enrich the API with more data by using includes |
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. |
Not applicable for this endpoint.
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.
Dynamic Filters | Available on Entity | Description | Examples |
|---|---|---|---|
countries | Filter regions and more based on countries. | &include=countries&filters=countryRegions:countryIDS | |
leagues | Filter regions and more based on cities. | &include=cities&filters=cityREgions:cityIDS |
Yes
You can use a total of
3 nested includes on this endpoint
Related Entities:
Get an overview and explanation of all the fields returned in the API response. The related entities for the regions' endpoints are:
Ruby
Python
PHP
Java
Node.js
Go
require "uri"
require "net/http"
url = URI("https://api.sportmonks.com/v3/core/regions/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", "/v3/core/regions/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/v3/core/regions/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/v3/core/regions/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/v3/core/regions/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/v3/core/regions/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 8mo ago