Teams

Retrieve the teams supported by the API.

Pagination

limit and offset, 500 per page

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

Each team carries an id and a name, and may carry a logo URL.

The id is the value other endpoints expect. It filters matches as homeTeamId or awayTeamId. It is the id path parameter on team statistics, teamId on last five games, and teamIdOne or teamIdTwo on head to head.

Parameters

Request

curl --request GET \
  --url 'https://hockey.highlightly.net/teams?name=Frankfurt%20Lowen' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

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

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

Response

Example response

{
  "data": [
    {
      "id": 223746,
      "logo": "https://example.com/logos/team/223746.png",
      "name": "Frankfurt Lowen"
    }
  ],
  "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