Teams

Retrieve the teams supported by the API.

Pagination

limit and offset

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

Abbreviations are short codes such as MS.

limit sets how many teams come back. When the number of matching teams exceeds it, request the next page by increasing offset. See Pagination and limits.

Resolving team ids

This endpoint is how you get the ids the rest of the API expects. Head to head and last five games take a team id rather than a name. The team filters on matches and highlights accept ids as well as names and abbreviations.

Resolve once, store the ids, and query by id afterwards. An id matches exactly.

Parameters

Request

curl --request GET \
  --url 'https://cricket.highlightly.net/teams?name=Melbourne%20Stars&abbreviation=MS' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'Melbourne Stars',
  abbreviation: 'MS'
})
const response = await fetch(`https://cricket.highlightly.net/teams?${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/teams',
    params={
        'name': 'Melbourne Stars',
        'abbreviation': 'MS',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

Example response

{
  "data": [
    {
      "id": "17838627",
      "logo": "https://example.com/logos/team/17838627.png",
      "name": "Melbourne Stars",
      "abbreviation": "MS"
    }
  ],
  "pagination": {
    "totalCount": 490,
    "offset": 20,
    "limit": 100
  },
  "plan": {
    "tier": "BASIC",
    "message": "Some results might be hidden with FREE tier. Check your API coverage for more information: https://rapidapi.com/highlightly-api-highlightly-api-default/api/sport-highlights-api/details"
  }
}

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

Errors