Teams

GET https://nhl.highlightly.net/teams NHL & NCAAH API

GET https://sports.highlightly.net/nhl/teams All Sports API

Retrieve the teams supported by the API.

Coverage: NHL and NCAA Division I
Pagination: Not paginated

Four filters narrow the list, and any of them works on its own.

Parameter	Use it for
`league`	The league a team plays in, such as `NHL` or `NCAA`.
`abbreviation`	The team's short code, such as `COR`.
`displayName`	The name as it is usually written out, such as `Cornell Big Red`.
`name`	Checking whether a specific team is supported.

Team ids and abbreviations

Matches and highlights accept homeTeamAbbreviation and awayTeamAbbreviation alongside the team id filters.

Ids are what head to head, last five games and team statistics expect, so resolve once here and store them.

Parameters

Parameter	Type	Description
`name`optional	string	No description in the spec.e.g. `Big Red`
`displayName`optional	string	No description in the spec.e.g. `Cornell Big Red`
`abbreviation`optional	string	No description in the spec.e.g. `COR`
`league`optional	string	No description in the spec.e.g. `NCAA`

Request

cURLJavaScriptPython

curl --request GET \
  --url 'https://nhl.highlightly.net/teams?name=Big%20Red&displayName=Cornell%20Big%20Red' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

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

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

Response

idnumberrequired

logostring

namestring

displayNamestringrequired

abbreviationstringrequired

leaguestringrequired

Example response

              200 application/json
            

              [
  {
    "id": 1,
    "logo": "https://example.com/logos/team/1.png",
    "name": "Stars",
    "displayName": "Dallas Stars",
    "abbreviation": "DAL",
    "league": "NHL"
  }
]
            

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

Errors

Status	Description
`400`	Bad request descriptive error.
`500`	Internal server error.