API 3.0
CoreOddsFootball APIAPI 2 (Deprecated)WidgetsContact
Core API 3.0
Core API 3.0
  • Core
  • Endpoints
    • πŸ—ΊοΈContinents
      • GET All Continents
      • GET Continent by ID
    • 🏳️Countries
      • GET All Countries
      • GET Country by ID
      • GET Countries by Search
    • 🏴Regions
      • GET All Regions
      • GET Region by ID
      • GET Regions by Search
    • πŸ™οΈCities
      • GET All Cities
      • GET City by ID
      • GET Cities by Search
    • ⌨️Types
      • GET All Types
      • GET Type by ID
      • GET Type by Entity
    • βš™οΈFilters
      • GET All Entity Filters
    • πŸ•°οΈTimezones
      • GET All Supported Time Zones
  • My Sportmonks
    • GET My Enrichments
    • GET My Resources
    • GET My Leagues
    • GET My Usage
  • Entities
    • 🌐Core
Powered by GitBook
On this page

Was this helpful?

  1. Endpoints
  2. Countries

GET Countries by Search

Returns country information that match your search query.

Last updated 2 years ago

Was this helpful?

https://api.sportmonks.com/v3/core/countries/search/{search_query}
{
  "data": {
    "id": 462,
    "continent_id": 1,
    "name": "United Kingdom",
    "official_name": "United Kingdom of Great Britain and Northern Ireland",
    "fifa_name": "ENG,NIR,SCO,WAL",
    "iso2": "GB",
    "iso3": "GBR",
    "latitude": "54.56088638305664",
    "longitude": "-2.2125117778778076",
    "geonameid": 2635167,
    "borders": [
      "IRL"
    ],
    "image_path": "https://cdn.sportmonks.com/images//countries/png/short/gb.png"
  },
Field
Description
Type

id

Refers to the id of the country

integer

continent_id

Refers to the continent of the country

integer

name

Displays the name of the country

string

official_name

Displays the officiel name of the country

string

fifa_name

Displays the official fifa shortcode name of the country

string

iso2

Returns the two letter country code

string

iso3

Returns the three letter country code

string

latitude

Returns the official latitude position of the country

string

longitude

Returns the official longitude position of the country

string

geonameid

Returns the official geonameid

integer

border

Returns all the neighbour countries of the country

string

image_path

Returns the image path of the country

string

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

regions

Filter countries and more based on regions.

&include=regions&filters=regionCountries:regionIDS

leagues

Filter countries and more based on leagues.

&include=leagues&filters=leagueCountries:leagueIDS

Pagination

Yes

Include depth

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

Include options

Related Entities:

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

Code Example

require "uri"
require "net/http"

url = URI("https://api.sportmonks.com/v3/core/countries/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/countries/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/countries/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/countries/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/countries/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/countries/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))
}

Select specific fields on the

Coaches, Leagues, Players, Teams, and way more. Check this for all possibilities.

Check this for all possibilities.

🏳️
base entity
endpoint
endpoint
leagues
continent
regions
Country