Countries

Retrieve the countries supported by the API.

Refresh interval

Once a day

Pagination

Not paginated

Country name and code are the starting point for most filtering. Both can be passed to matches, leagues and highlights as countryName and countryCode.

Use the name query parameter to check whether a specific country is supported, or to fetch just its record rather than the whole list.

Codes follow the ISO 3166 standard, for example AU. Each country also carries a logo URL.

Parameters

Request

curl --request GET \
  --url 'https://cricket.highlightly.net/countries?name=Australia' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'Australia'
})
const response = await fetch(`https://cricket.highlightly.net/countries?${params}`, {
  headers: {
    'x-rapidapi-key': process.env.HIGHLIGHTLY_API_KEY
  }
})

if (!response.ok) {
  throw new Error(`Highlightly responded ${response.status}`)
}

const data = await response.json()

import os
import requests

response = requests.get(
    'https://cricket.highlightly.net/countries',
    params={
        'name': 'Australia',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

response.raise_for_status()
data = response.json()

Response

Example response

[
  {
    "code": "AU",
    "name": "Australia",
    "logo": "https://example.com/logos/country/AU.png"
  }
]

Values are the examples declared in the OpenAPI spec, not a captured live response.

Errors