Getting started

Before your first request, you will need an API key. Send it in the x-rapidapi-key header with every request. The first segment of every path is the sport.

Your first request

Sign up at Highlightly or through RapidAPI, then fetch a day of football matches.

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

const response = await fetch('https://sports.highlightly.net/football/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/football/matches?date=2023-08-06',
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

If that returns data, you are set up correctly. If it returns 401 or 403, check Errors.

What every request needs

Past that, an endpoint behaves exactly as it does in the sport's own product. Same parameters, response and refresh interval.

Where to go next

The payload for any endpoint is in that sport's own documentation, which is linked from endpoint coverage.

OpenAPI specification

Import the OpenAPI 3.0 document into Postman or Insomnia, or generate a client from it.