HIhighlightly
Basketball.Highlights

Get all 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 1 to 48 hours after a match is finished.

Highlights represent the core of our API. They include various different kinds of clips ranging from real time live events such as insane plays, last minute scores to full game recaps, pre/post match interviews.

Currently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:

TypeDescription
VERIFIEDVideos come from reputable sources that have been thoroughly inspected. In most cases the clips are from official authors who own the copyrights to the video itself. The hosting platform can impose geo restrictions or prevent direct embedding (highlights/geo-restrictions/{highlightId} route can be used to check for potential restrictions). Verified highlights are uploaded anywhere from 1 to 48 hours of the match being finished.
UNVERIFIEDHighlights vary and might not have gone through the verification process or are considered user uploaded. Videos include a wide spectrum of topics such as last minute scores, memorable plays, game recaps, etc. Unverified highlights are considered more real time and might be uploaded even when the match is still being played. The lifetime of these clips vary and is dependant on the hosting platform.

Each highlight has a title which describes what the video is about. Certain entries will have a description as well which is used to further describe the associated clip. The source field defines where the clip was aggregated from (e.g. would be youtube, twitter, reddit, espn, etc.). For certain sources you will see additional information being present in the channel field. By utilising this information you can further narrow down which videos you want to showcase. Highlights might also have an embedUrl property which is used to directly embed the videos into your website or mobile application.

Below is an example of what you can aim to achieve with our highlights data:

Highlights example

Retrieve highlights

Retrieve a list of highlights 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 highlights relevant to your location.

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

Note: The Basic/Free plan might have certain restrictions in place. More information can be found here.

get/basketball/highlights

Request

Query parameters

countryCodestring
Example:AU

Country code specified by the ISO 3166 standard.

countryNamestring
Example:Australia
leagueNamestring
Example:NBL
leagueIdnumber
Example:1635
datestring
Example:2023-10-01

Date that follows the YYYY-MM-DD format.

timezonestring
Example:Europe/London

Valid timezone identifier.

seasonnumber
Example:2023
matchIdnumber
Example:299340885
homeTeamIdnumber
Example:7592
awayTeamIdnumber
Example:1635
homeTeamNamestring
Example:Adelaide
awayTeamNamestring
Example:Melbourne United
limitnumber
Example:40
offsetnumber

Headers

x-rapidapi-hoststring required

sport-highlights-api.p.rapidapi.com

x-rapidapi-keystring required

Rapid API Token

Response

Example response

{
  "data": [
    {
      "id": 28,
      "type": "VERIFIED",
      "imgUrl": "https://example.com/images/preview/28.png",
      "title": "NBL: Adelaide vs Melbourne United",
      "description": "Game recap of the match.",
      "url": "https://example.com/highlight/213123safas132e",
      "embedUrl": "https://example.com/embed/213123safas132e",
      "match": {
        "id": 489389,
        "week": "1",
        "stage": "Final",
        "date": "2023-10-01T03:00:00.000Z",
        "country": {
          "code": "AU",
          "name": "Australia",
          "logo": "https://example.com/logos/country/AU.png"
        },
        "awayTeam": {
          "id": 7592,
          "logo": "https://example.com/logos/team/7592.png",
          "name": "Adelaide"
        },
        "homeTeam": {
          "id": 7592,
          "logo": "https://example.com/logos/team/7592.png",
          "name": "Adelaide"
        },
        "league": {
          "id": 1635,
          "season": 2023,
          "name": "NBL",
          "logo": "https://example.com/logos/league/1635.png"
        },
        "state": {
          "description": "Finished",
          "clock": 9,
          "score": {
            "current": "105 - 104",
            "q1": "22 - 15",
            "q2": "17 - 33",
            "q3": "11 - 27",
            "q4": "33 - 14",
            "overTime": "22 - 15"
          }
        }
      },
      "channel": "NBA",
      "source": "youtube"
    }
  ],
  "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.