API docs by Redocly

Highlightly NFL, NCAA API (3.1.1)

Download OpenAPI specification:Download

The API provides a standardized way for developers to interact with the service and retrieve NFL, NCAA data. With this API, users can request highlights based on various parameters such as team, match, league, or specific timeframes. The specification defines the endpoints and their corresponding operations, such as retrieving a list of all available highlights, retrieving a specific highlight by its ID, filtering highlights based on specific criteria, and more. The API specification also includes detailed information about the data models used, such as the structure of a highlight object, including properties like title, description, teams involved, players featured, and video URLs. In addition to the basic functionality, the API specification may also include optional features such as pagination for retrieving large result sets, sorting and filtering options, and authentication mechanisms for secure access to the API.

NFL, NCAA API

American Football.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters
name
object
Example: name=Miners
displayName
object
Example: displayName=UTEP Miners
abbreviation
object
Example: abbreviation=UTEP
league
object
Example: league=NCAA
header Parameters
x-rapidapi-host
required
string

nfl-ncaa-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[]

Get team by id.

Retrieve team details by team id.

path Parameters
id
required
number
Example: 21

Requested team id.

header Parameters
x-rapidapi-host
required
string

nfl-ncaa-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[]

American Football.Matches

Get all matches.

Retrieve a list of all matches.

query Parameters
league
object
Example: league=NCAA
date
object
Example: date=2023-08-26

Date that follows the YYYY-MM-DD format.

timezone
object
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.

season
object
Example: season=2023
homeTeamId
object
Example: homeTeamId=21
awayTeamId
object
Example: awayTeamId=22
homeTeamName
object
Example: homeTeamName=Gamecocks
awayTeamName
object
Example: awayTeamName=Miners
homeTeamAbbreviation
object
Example: homeTeamAbbreviation=JVST
awayTeamAbbreviation
object
Example: awayTeamAbbreviation=UTEP
homeTeamDisplayName
object
Example: homeTeamDisplayName=Jacksonville State Gamecocks
awayTeamDisplayName
object
Example: awayTeamDisplayName=UTEP Miners
limit
number [ 0 .. 100 ]
Default: 100
Example: limit=100
offset
number >= 0
Default: 0
header Parameters
x-rapidapi-host
required
string

nfl-ncaa-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "plan": {
    }
}

Get match by id.

Retrieve match details by match id.

path Parameters
id
required
number
Example: 39

Requested match id.

header Parameters
x-rapidapi-host
required
string

nfl-ncaa-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

American Football.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters
league
object
Example: league=NCAA
date
object
Example: date=2023-09-01

Date that follows the YYYY-MM-DD format.

timezone
object
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.

season
object
Example: season=2023
matchId
object
Example: matchId=35
homeTeamId
object
Example: homeTeamId=69
awayTeamId
object
Example: awayTeamId=70
homeTeamName
object
Example: homeTeamName=Eagles
awayTeamName
object
Example: awayTeamName=Bison
homeTeamAbbreviation
object
Example: homeTeamAbbreviation=EMU
awayTeamAbbreviation
object
Example: awayTeamAbbreviation=HOW
homeTeamDisplayName
object
Example: homeTeamDisplayName=Eastern Michigan Eagles
awayTeamDisplayName
object
Example: awayTeamDisplayName=Howard Bison
limit
number [ 0 .. 40 ]
Default: 40
offset
number >= 0
Default: 0
header Parameters
x-rapidapi-host
required
string

nfl-ncaa-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "pagination": {
    },
  • "plan": {
    }
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters
id
required
number
Example: 12774

Requested higlight id.

header Parameters
x-rapidapi-host
required
string

nfl-ncaa-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "state": "Allowed countries restriction",
  • "allowedCountries": [
    ],
  • "blockedCountries": [ ],
  • "embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters
id
required
number
Example: 12

Requested highlight id.

header Parameters
x-rapidapi-host
required
string

nfl-ncaa-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[]

American Football.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters
teamId
required
number
Example: teamId=21
header Parameters
x-rapidapi-host
required
string

nfl-ncaa-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

American Football.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters
teamIdOne
required
number
Example: teamIdOne=13
teamIdTwo
required
number
Example: teamIdTwo=3
header Parameters
x-rapidapi-host
required
string

nfl-ncaa-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]