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.

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

Team and league filters take either an id or a name. homeTeamId, awayTeamId and leagueId come from teams and leagues, and homeTeamName, awayTeamName and leagueName match by name.

Match states

Every match carries a state object. The state value itself is in state.description, the score is in state.score, and state.clock gives the current minute when present.

So this endpoint is enough to show a score. The detail route is not needed for it.

The values of state.description are below. Polling a fixture through to its conclusion means handling all of them.

Parameters

Request

curl --request GET \
  --url 'https://soccer.highlightly.net/matches?leagueName=Superettan&leagueId=97798' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

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

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

Response

Example response

{
  "data": [
    {
      "id": 489389,
      "round": "Regular Season - 32",
      "date": "2023-05-20T15:30:00.000Z",
      "country": {
        "code": "FR",
        "name": "France",
        "logo": "https://example.com/logos/country/FR.png"
      },
      "awayTeam": {
        "id": 553,
        "logo": "https://example.com/logos/team/553.png",
        "name": "Montpellier",
        "type": "club"
      },
      "homeTeam": {
        "id": 553,
        "logo": "https://example.com/logos/team/553.png",
        "name": "Montpellier",
        "type": "club"
      },
      "league": {
        "id": 133,
        "season": 2023,
        "name": "Ligue 1",
        "logo": "https://example.com/logos/league/133.png"
      },
      "state": {
        "description": "Second half",
        "clock": 67,
        "score": {
          "current": "3 - 1",
          "penalties": "6 - 4"
        }
      }
    }
  ],
  "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