Download OpenAPI specification:Download
The API provides a standardized way for developers to interact with the service and retrieve NFL, NCAA highlights 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.
Retrieve a list of all teams.
name | object Example: name=Miners |
displayName | object Example: displayName=UTEP Miners |
abbreviation | object Example: abbreviation=UTEP |
league | object Example: league=NCAA |
x-rapidapi-host required | string nfl-ncaa-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO",
- "league": "NFL"
}
]
Retrieve team details by team id.
id required | number Example: 21 Requested team id. |
x-rapidapi-host required | string nfl-ncaa-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO",
- "league": "NFL"
}
]
Retrieve a list of all matches.
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 | object [ 0 .. 100 ] Default: 100 Example: limit=100 |
offset | object >= 0 Default: 0 |
x-rapidapi-host required | string nfl-ncaa-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "id": 1,
- "round": "Regular Season - 32",
- "date": "2023-05-20T15:30:00.000Z",
- "league": "NFL",
- "season": 2023,
- "awayTeam": {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO"
}, - "homeTeam": {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO"
}
}
], - "pagination": {
- "totalCount": 490,
- "offset": 20,
- "limit": 100
}
}
Retrieve match details by match id.
id required | number Example: 39 Requested match id. |
x-rapidapi-host required | string nfl-ncaa-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 1,
- "round": "Regular Season - 32",
- "date": "2023-05-20T15:30:00.000Z",
- "league": "NFL",
- "season": 2023,
- "awayTeam": {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO"
}, - "homeTeam": {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO"
}
}
]
Retrieve a list of all highlights.
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 | object [ 0 .. 40 ] Default: 40 |
offset | object >= 0 Default: 0 |
x-rapidapi-host required | string nfl-ncaa-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "id": 1,
- "type": "VERIFIED",
- "title": "NFL: New Orleans Saints vs Kansas City Chiefs",
- "description": "Game recap of the match.",
- "match": {
- "id": 1,
- "round": "Regular Season - 32",
- "date": "2023-05-20T15:30:00.000Z",
- "league": "NFL",
- "season": 2023,
- "awayTeam": {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO"
}, - "homeTeam": {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO"
}
}
}
], - "pagination": {
- "totalCount": 490,
- "offset": 20,
- "limit": 100
}
}
Retrieve highlight details by highlight id.
id required | number Example: 12 Requested highlight id. |
x-rapidapi-host required | string nfl-ncaa-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 1,
- "type": "VERIFIED",
- "title": "NFL: New Orleans Saints vs Kansas City Chiefs",
- "description": "Game recap of the match.",
- "match": {
- "id": 1,
- "round": "Regular Season - 32",
- "date": "2023-05-20T15:30:00.000Z",
- "league": "NFL",
- "season": 2023,
- "awayTeam": {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO"
}, - "homeTeam": {
- "id": 1,
- "name": "Saints",
- "displayName": "New Orleans Saints",
- "abbreviation": "NO"
}
}
}
]