American Football Highlights API
The Highlightly NFL & NCAA API provides real-time American football data including live scores, video highlights, game statistics, player profiles and stats,…
Data & analytics#sports--fitness
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Highlightly NFL & NCAA API provides real-time American football data including live scores, video highlights, game statistics, player profiles and stats, depth charts, standings, predictions, and live play-by-play events. Covers NFL preseason, regular season, playoffs, and championship games plus NCAA FBS.
Contact
For feature requests, questions, private plans or business inquiries you can contact us at [support@highlightly.net](mailto:support@highlightly.net).
You can also contact us via RapidAPI by starting a discussion or by sending us a private message.
Integration
To start using our API services you will first need to create an account via Highlightly or RapidAPI.
Both platforms offer you the ability to view the API analytics, manage billing settings, control API keys and much more. However, there are a few differences. RapidAPI does not include custom plans nor does it provide long term plan discounts.
> Accounts are not synced across platforms.
> Please ensure that your API key is not made public to prevent potential abuse. Your API key can be managed either through Highlightly or RapidAPI.
API usage
> Highlightly API base url: https://american-football.highlightly.net
> RapidAPI API base url: https://nfl-ncaa-highlights-api.p.rapidapi.com
Each API request will be considered valid only if the following headers are present:
| Request Header | Value |
|---|---|
x-rapidapi-key | Your Highlightly or RapidAPI API Key |
x-rapidapi-host | nfl-ncaa-highlights-api.p.rapidapi.com - only needed for usage through RapidAPI |
These headers are mandatory when requesting API data. They are not needed when requesting other resources such as logos or images.
Each API response will contain additional headers. The following three are considered the most important for developers:
| Response Header | Value |
|---|---|
x-ratelimit-requests-limit | This is a static value indicating the number of requests the plan you are currently subscribed to allows you to make. |
x-ratelimit-requests-remaining | The number of requests remaining (from your plan) before you reach the limit of requests your application is allowed to make. When this reaches zero, you will not be able to make any requests until your daily quota is reset. You can view these limits and quotas on the pricing page of the API in the API Hub. |
content-type | Value will always be application/json. XML format is not supported. |
In the following sections we will guide you through all endpoints and functionalities the API has to offer.
Endpoints 19
American Football.Teams
- GETGet all teams
/teamsRetrieve a list of teams that are supported by the API. By utilising either league, name, displayName or abbreviation query parameters you can check whether a… - GETGet team statistics
/teams/statistics/:id?fromDate=2023-08-06> Refresh interval: Immediately once a match is finished. Retrieve team stats for each league and season by specifying the team's id path parameter. Requires… - GETGet team by team id
/teams/:idRetrieve team information by specifying the team id path parameter. > Note: Used to check whether a team still exists or had its information updated.
American Football.Matches
- GETGet all matches
/matches> Refresh interval: Once a minute > Route returns only general match information. For additional match details check the matches/{matchId} route. Retrieve a… - GETGet match by id
/matches/:idRetrieve detailed match information by specifying the match id path parameter. Fetched data will have additional information about the venue, weather…
American Football.Highlights
- GETGet all highlights
/highlights> Refresh interval: Once a minute > Note: Certain highlights might be uploaded whilst the game is playing. Full game recaps tend to be uploaded anywhere from… - GETGet geo restrictions for highlight
/highlights/geo-restrictions/:id> Refresh interval: Once an hour > Note: Endpoint is not available in the Basic/Free plan. Geo restrictions are a plague that have been around for quite a… - GETGet highlight by id
/highlights/:idRetrieve highlight information by specifying the highlight id path parameter. > Note: Used to check whether a highlight still exists or had its information…
American Football.Last Five Games
- GETGet last five finished games for a specific team id
/last-five-games?teamId=92730> Refresh interval: Immediately once a game is considered finished Retrieve a list of the last five finished games for a specific team. If a game was not…
American Football.Head 2 Head
- GETGet head 2 head games
/head-2-head?teamIdOne=92730&teamIdTwo=92731Retrieve a list of the last ten head 2 head games between two teams. Compare the two teams to find out who is stronger based on their past match results.…
American Football.Bookmakers
- GETGet all bookmakers
/bookmakers> Refresh interval: Once a day Retrieve a list of supported bookmakers. There are two important parameters that are used to navigate through the pagination.… - GETGet bookmaker by id
/bookmakers/:idRetrieve bookmaker information by specifying the bookmaker id path parameter. > Note: Used to check whether a bookmaker still exists or had its information…
American Football.Odds
- GETGet all odds
/odds> Prematch odds refresh interval: Multiple times a day > Live odds refresh interval: Once every 10 minutes > Note: Endpoint is not available in the Basic/Free…
American Football.Standings
- GETGet standings
/standings> Refresh interval: Up to an hour after a match for the associated league and season is finished Retrieve standings data for a specific league, conference or…
American Football.Lineups
- GETGet linups by match id
/lineups/:matchId> Lineups should be queried up to a few hours before the game starts. Retrieve home and away team lineups for a specific match. Below is an example of what…
American Football.Players
- GETGet all players
/players> Refresh interval: 15 minutes > Route returns only general player information. For additional player details check the players/{playerId} and… - GETGet player summary by player id
/players/:id> Refresh interval: Once a day Retrieve detailed player summary by specifying the player id path parameter. Detailed player summary consists of the following… - GETGet player statistics by player id
/players/:id/statistics> Refresh interval: Once a day Retrieve detailed player statistics by specifying the player id path parameter. Detailed player statistics are aggregated on a…
American Football.Match Box Score
- GETRetrieve player box scores for specified match id
/box-score/:matchId> Refresh interval: Every minute Retrieve detailed per-player American Football box score statistics by specifying the matchId as the path parameter. The…
API details
- Base URL
https://american-football.highlightly.nethttps://nfl-ncaa-highlights-api.p.rapidapi.com- Authentication
- None declared in the description
- Operations
- 19 operations on 19 pathsGET 19
- Main resources
- American Football.Highlights 3American Football.Players 3American Football.Teams 3American Football.Bookmakers 2American Football.Matches 2American Football.Head 2 Head 1American Football.Last Five Games 1American Football.Lineups 1American Football.Match Box Score 1American Football.Odds 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
8.2.2 - Links
- OpenAPI document
How to test the American Football Highlights API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the American Football Highlights API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Get all teams” (GET /teams), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the American Football Highlights API?
The Highlightly NFL & NCAA API provides real-time American football data including live scores, video highlights, game statistics, player profiles and stats,… It is listed under Data & analytics and has 19 endpoints.
Who publishes the American Football Highlights API?
It is listed from Highlightly's public API description (an OpenAPI document), not published by Highlightly on Swastik Codes. Anyone who controls highlightly.net can claim the profile by adding a DNS TXT record.
What is the base URL of the American Football Highlights API?
Its description lists 2 base URLs: https://american-football.highlightly.net, https://nfl-ncaa-highlights-api.p.rapidapi.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the American Football Highlights API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the American Football Highlights API have?
19 operations on 19 paths (19 GET). The largest groups are American Football.Highlights, American Football.Players, American Football.Teams, American Football.Bookmakers.
Is forking the American Football Highlights API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.