Teams

GET https://american-football.highlightly.net/teams NFL & NCAAF API

GET https://sports.highlightly.net/american-football/teams All Sports API

Retrieve the teams supported by the API.

Coverage: NFL and NCAA FBS
Pagination: Not paginated

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

Parameter	Use it for
`league`	Filtering by league, such as `NFL`.
`abbreviation`	The short code you already show in a scoreboard, such as `CIN`.
`displayName`	The name as it is usually written out.
`name`	Checking whether a specific team is supported.

Abbreviations are the practical key

Most of this API is reached by id. Matches and highlights accept homeTeamAbbreviation and awayTeamAbbreviation, so you can filter them by abbreviation directly without resolving an id first.

Ids are still 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. `Bengals`
`displayName`optional	string	No description in the spec.e.g. `Cincinnati Bengals`
`abbreviation`optional	string	No description in the spec.e.g. `CIN`
`league`optional	string	No description in the spec.e.g. `NFL`

Request

cURLJavaScriptPython

curl --request GET \
  --url 'https://american-football.highlightly.net/teams?name=Bengals&displayName=Cincinnati%20Bengals' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'Bengals',
  displayName: 'Cincinnati Bengals'
})
const response = await fetch(`https://american-football.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://american-football.highlightly.net/teams',
    params={
        'name': 'Bengals',
        'displayName': 'Cincinnati Bengals',
    },
    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/111.png",
    "name": "Saints",
    "displayName": "New Orleans Saints",
    "abbreviation": "NO",
    "league": "NFL"
  }
]
            

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.