Teams
Retrieve the teams supported by the API.
- Coverage
- NBA and NCAA Division I
- Pagination
- Not paginated
Each filter works on its own and matches the whole value, ignoring case, so
den finds DEN.
| Parameter | Use it for |
|---|---|
league |
Separating professional from college. One of NBA or
NCAA, in any case. Any other value is ignored and the full list is
returned.
|
abbreviation |
The team's short code, such as DEN. |
displayName |
The name as it is usually written out, such as Denver Nuggets. |
name |
The short team name, such as Nuggets. |
Ids and abbreviations
Matches and
highlights accept
homeTeamAbbreviation and awayTeamAbbreviation, so those two
can be filtered by abbreviation without resolving an id first.
Head to head, last five games, team statistics and get team by ID take the team id, so resolve it once here and store it.
Parameters
| Parameter | Type | Description |
|---|---|---|
nameoptional |
string |
No description in the spec.e.g. Nuggets
|
displayNameoptional
|
string |
No description in the spec.e.g. Denver Nuggets
|
abbreviationoptional
|
string |
No description in the spec.e.g. DEN
|
leagueoptional |
string |
No description in the spec.e.g. NBA
|
Request
curl --request GET \
--url 'https://nba.highlightly.net/teams?name=Nuggets&displayName=Denver%20Nuggets' \
--header 'x-rapidapi-key: YOUR_API_KEY'
const params = new URLSearchParams({
name: 'Nuggets',
displayName: 'Denver Nuggets'
})
const response = await fetch(`https://nba.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://nba.highlightly.net/teams',
params={
'name': 'Nuggets',
'displayName': 'Denver Nuggets',
},
headers={
'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
},
timeout=10,
)
response.raise_for_status()
data = response.json()
Response
idnumberrequired
logostring
namestring
displayNamestringrequired
abbreviationstringrequired
leaguestringrequiredNBANCAA
Example response
[
{
"id": 28,
"logo": "https://highlightly.net/nba/images/teams/28.png",
"name": "Rockets",
"displayName": "Houston Rockets",
"abbreviation": "HOU",
"league": "NBA"
}
]
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. |