HIhighlightly
American Football.Matches

Get all matches

Refresh interval: Once a minute

Route returns only general match information. For additional match details check the matches/{matchId} route.

Retrieve a list of matches based on the requested query parameters.

At least one primary query parameter needs to be specified before you can retrieve the data (timezone, limit, offset are considered secondary).

You can specify the timezone field in combination with the date query parameter to get matches relevant to your location.

There are two other important parameters. The limit parameter defines what the number of returned matches will be. If the number of actual matches is above the limit value you can make subsequent requests by increasing the offset value.

Matches have different possible states they can be in:

StateDescription
PostponedMatch has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future.
SuspendedMatch has already been in play but was suspended. In the future the game will resume from the exact point where it was halted.
CancelledGame will not be played.
AbandonedConsidered "abandoned" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game might be resumed from the exact point where it was halted.
FinishedMatch has been concluded.
ScheduledMatch has not been started yet.
End periodBreak time between periods.
Half timeHalf time pause between second and third quarter.
In progressGame is currently in progress.
UnknownUnknown match coverage or state.

Below is an example of what you can aim to achieve with the matches endpoint:

American football matches example

get/american-football/matches

Request

Query parameters

leaguestring
Example:NFL
datestring
Example:2024-08-23

Date that follows the YYYY-MM-DD format.

timezonestring
Example:Europe/London

Valid timezone identifier.

seasonnumber
Example:2024
homeTeamIdnumber
Example:92730
awayTeamIdnumber
Example:92731
homeTeamNamestring
Example:Bengals
awayTeamNamestring
Example:Colts
homeTeamAbbreviationstring
Example:CIN
awayTeamAbbreviationstring
Example:IND
homeTeamDisplayNamestring
Example:Cincinnati Bengals
awayTeamDisplayNamestring
Example:Indianapolis Colts
limitnumber
Example:100
offsetnumber

Headers

x-rapidapi-hoststring required

sport-highlights-api.p.rapidapi.com

x-rapidapi-keystring required

Rapid API Token

Response

Example response

{
  "data": [
    {
      "id": 1,
      "round": "Regular Season - 32",
      "date": "2023-05-20T15:30:00.000Z",
      "league": "NFL",
      "season": 2023,
      "awayTeam": {
        "id": 1,
        "logo": "https://example.com/logos/team/111.png",
        "name": "Saints",
        "displayName": "New Orleans Saints",
        "abbreviation": "NO"
      },
      "homeTeam": {
        "id": 1,
        "logo": "https://example.com/logos/team/111.png",
        "name": "Saints",
        "displayName": "New Orleans Saints",
        "abbreviation": "NO"
      },
      "state": {
        "period": 2,
        "clock": 8,
        "description": "In progress",
        "score": {
          "current": "21 - 7",
          "firstPeriod": "0 - 0",
          "secondPeriod": "7 - 7",
          "thirdPeriod": "7 - 0",
          "fourthPeriod": "7 - 0",
          "firstOvertimePeriod": "7 - 0",
          "secondOvertimePeriod": "7 - 0"
        },
        "report": "Final"
      }
    }
  ],
  "pagination": {
    "totalCount": 490,
    "offset": 20,
    "limit": 100
  },
  "plan": {
    "tier": "BASIC",
    "message": "Some results might be hidden with FREE tier. Check your API coverage for more information: https://rapidapi.com/highlightly-api-highlightly-api-default/api/sport-highlights-api/details"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.