Endpoint coverage
Check which endpoints your prefix carries before you build a path against it.
Where the payload is documented
An endpoint reached through sports.highlightly.net returns exactly what the
sport's own API returns. Parameters, response fields and refresh intervals are the
same, so the sport's own documentation is the complete answer for anything below.
| Prefix | Endpoint reference |
|---|---|
/football |
Football API |
/american-football |
NFL & NCAAF API |
/nba |
NBA & NCAAB API |
/baseball |
MLB & NCAA API |
/nhl |
NHL & NCAAH API |
/cricket |
Cricket API |
/basketball |
Basketball API |
/hockey |
Hockey API |
/rugby |
Rugby API |
/volleyball |
Volleyball API |
/handball |
Handball API |
Endpoints every prefix carries
These take the same path whichever prefix you put in front.
| Endpoint | Returns |
|---|---|
/matches |
Schedules and live scores. |
/matches/{id} |
One match, with whatever detail the sport carries. |
/highlights |
Video clips. |
/highlights/{id} |
One clip. |
/highlights/geo-restrictions/{id} |
Where a clip can be shown, and whether it embeds. |
/teams |
The teams covered. |
/teams/{id} |
One team. |
/standings |
League tables. |
/head-2-head |
Past meetings between two teams. |
/last-five-games |
A team's recent form. |
/odds |
Prematch and live odds. |
/bookmakers |
The bookmakers covered. |
/bookmakers/{id} |
One bookmaker. |
Endpoints by prefix
The rest are carried by the prefixes named beside them.
| Endpoint | Prefixes that have it |
|---|---|
/events/{id} |
/football |
/statistics/{matchId} |
/football, /basketball |
/statistics/{id} |
/baseball |
/box-score/{matchId} |
/football, /american-football, /nba
|
/box-scores/{id} |
/baseball |
/lineups/{matchId} |
/football, /american-football, /nba,
/baseball, /nhl
|
/players |
/football, /american-football, /nba,
/baseball, /nhl, /cricket
|
/players/{id} |
/football, /american-football, /nba,
/baseball, /nhl, /cricket
|
/players/{id}/statistics |
/football, /american-football, /nba,
/baseball, /nhl
|
/teams/statistics/{id} |
/football, /american-football, /nba,
/baseball, /nhl, /basketball,
/hockey, /rugby, /volleyball,
/handball
|
/leagues |
/football, /cricket, /basketball,
/hockey, /rugby, /volleyball,
/handball
|
/leagues/{id} |
/football, /cricket, /basketball,
/hockey, /rugby, /volleyball,
/handball
|
/countries |
/football, /cricket, /basketball,
/hockey, /rugby, /volleyball,
/handball
|
/countries/{countryCode} |
/football, /cricket, /basketball,
/hockey, /rugby, /volleyball,
/handball
|
/american-football, /baseball, /nba and
/nhl carry no /countries or /leagues, and they
name several filters differently. Those names are in
parameter conventions.
Plan coverage
The Basic and Free plans restrict what some sports return. A Pro plan or higher removes the restrictions.
| Prefix | Highlights on the Basic and Free plans |
|---|---|
/football |
The Free plan returns a fixed set of leagues, listed under Football highlights. |
/american-football |
NFL highlights are excluded on Basic. |
/nba |
NBA highlights are excluded on Basic. |
/baseball |
MLB highlights are excluded on Basic. |
/nhl |
NHL highlights are excluded on Basic. |
/cricket |
Every league. |
/basketball |
Seven leagues are excluded, listed under Basketball highlights. |
/hockey |
Seven leagues are excluded, listed under Hockey highlights. |
/rugby |
Every league. |
/volleyball |
Every league. |
/handball |
Every league. |
Odds are not available on the Basic and Free plans, and neither are geo restrictions. Both apply to every prefix that carries them.
