Teams

Retrieve the teams supported by the API.

Pagination

limit and offset

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

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, last five games and team statistics all take a team id rather than a name, as do the homeTeamId and awayTeamId filters on matches and highlights.

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

Clubs and national teams

A team can carry a type of either club or national, so the list covers both club and national teams.

Pass the type query parameter, for example club, when your product only deals with one.

Parameters

Request

curl --request GET \
  --url 'https://soccer.highlightly.net/teams?name=Sk%C3%B6vde%20AIK&type=club' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'Skövde AIK',
  type: 'club'
})
const response = await fetch(`https://soccer.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://soccer.highlightly.net/teams',
    params={
        'name': 'Skövde AIK',
        'type': 'club',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

Example response

{
  "data": [
    {
      "id": 553,
      "logo": "https://example.com/logos/team/553.png",
      "name": "Montpellier",
      "type": "club"
    }
  ],
  "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