Matches

Retrieve a list of matches.

Refresh interval

Once a minute

Pagination

limit and offset

Detail

General information only

Querying

At least one primary query parameter must be specified before you can retrieve data. timezone, limit and offset are secondary and do not count on their own.

Combine timezone with date to get matches relevant to your own location rather than UTC.

Teams can be filtered by id through homeTeamId and awayTeamId, or by name through homeTeamName and awayTeamName. Country and league filters narrow the same list further.

limit sets how many matches come back. When the number of matching games exceeds it, request the next page by increasing offset. See Pagination and limits.

State and score

Every match carries a state, holding the state description and, when present, the score.

The score is a single string in the 47 - 14 home and away form, rather than a breakdown by half. Split on the separator when you need the two numbers, and read the state to know whether that figure is final.

Match states

Parameters

Request

curl --request GET \
  --url 'https://rugby.highlightly.net/matches?leagueName=Six%20Nations%20U20&leagueId=48440' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  leagueName: 'Six Nations U20',
  leagueId: '48440'
})
const response = await fetch(`https://rugby.highlightly.net/matches?${params}`, {
  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://rugby.highlightly.net/matches',
    params={
        'leagueName': 'Six Nations U20',
        'leagueId': '48440',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

Example response

{
  "data": [
    {
      "id": 36224450,
      "week": "4",
      "date": "2024-03-08T19:15:00.000Z",
      "country": {
        "code": "EU",
        "name": "Europe",
        "logo": "https://example.com/logos/country/EU.png"
      },
      "awayTeam": {
        "id": 384585,
        "logo": "https://example.com/logos/team/90990.png",
        "name": "Italy U20"
      },
      "homeTeam": {
        "id": 384585,
        "logo": "https://example.com/logos/team/90990.png",
        "name": "Italy U20"
      },
      "league": {
        "id": 48440,
        "season": 2024,
        "name": "Six Nations U20",
        "logo": "https://example.com/logos/league/48440.png"
      },
      "state": {
        "description": "Finished",
        "score": "47 - 14"
      }
    }
  ],
  "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"
  }
}

Values are the examples declared in the OpenAPI spec, not a captured live response.

Errors