Authentication

Every request carries your API key in a header.

Request headers

Calling directly against sports.highlightly.net needs the key alone.

These headers apply to API data only. They are not needed when fetching other resources such as team logos or highlight preview images, which are plain public URLs.

Moving from a single sport product

The base URL and the path change on both platforms, and on RapidAPI the host header and the key change too.

Every sport product has its own pair of hosts in the same way. The prefix table in sports and path prefixes names which product each prefix corresponds to.

Request

curl --request GET \
  --url 'https://sports.highlightly.net/cricket/matches?date=2023-08-06' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const response = await fetch('https://sports.highlightly.net/cricket/matches?date=2023-08-06', {
  headers: {
    'x-rapidapi-key': process.env.HIGHLIGHTLY_API_KEY
  }
})

if (!response.ok) {
  throw new Error(`Highlightly responded ${response.status}`)
}

const data = await response.json()

import os
import requests

response = requests.get(
    'https://sports.highlightly.net/cricket/matches?date=2023-08-06',
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

response.raise_for_status()
data = response.json()

Keep the key private

Keys are managed from your account on Highlightly or on RapidAPI, depending on which one issued it. Accounts are not synced between the two.

Response headers

Every response carries rate limit information alongside the data.

One quota covers every sport prefix, so a request to /cricket/matches and one to /nba/matches draw on the same allowance. See Pagination and limits for how your subscription affects the data retrieved.