Rugby API
The Highlightly Rugby API provides real time rugby data including live scores, video highlights, team statistics, standings, head to head data and last five games.
Coverage spans 100+ competitions, among them the World Cup, Six Nations, the Rugby Championship, Champions Cup, Premiership Rugby, Top 14, Super Rugby, Major League Rugby, the Sevens World Series and women's competitions including WXV.
- Base URL
- rugby.highlightly.net
- Endpoints
- 18
- Format
- JSON only
- Version
- 6.2.4
Also available with an All Sports API subscription at
sports.highlightly.net/rugby.
See base URLs.
Where to start
Read Authentication first, since every request needs an API key. Pagination and limits covers paging and how your plan affects results.
| If you want | Start at |
|---|---|
| Tries, replays and game recaps | Highlights |
| Schedules and live scores | Matches |
| Team sheets, venue and referee | Get match by ID |
| League, pool and group tables | Standings |
Finding a competition to query
Matches, highlights, odds and standings are filtered by league. Start
from
countries to find
the code for a territory, then
leagues to get the
leagueId and the seasons it has data for.
Countries here are not only nations. A continental body such as Europe has its own code, which is how a cross border competition is grouped.
Those values unlock
standings, and
leagueId alone filters
matches,
highlights and
odds.
Base URLs
Rugby data is available two ways. A Rugby API subscription covers rugby alone. An All Sports API subscription covers rugby and all other Highlightly sports under one key. Either one can be bought directly from Highlightly or through RapidAPI, which gives four base URLs.
| Subscription | Platform | Base URL |
|---|---|---|
| Rugby API | Highlightly | https://rugby.highlightly.net |
| Rugby API | RapidAPI |
https://rugby-highlights-api.p.rapidapi.com
|
| All Sports API | Highlightly | https://sports.highlightly.net/rugby |
| All Sports API | RapidAPI |
https://sport-highlights-api.p.rapidapi.com/rugby
|
Every endpoint in this reference is available on all four. On Highlightly, one API key works for every product, and the data returned depends on your subscription to that product. On RapidAPI, each product is separate and needs its own API key.
To call an endpoint, append its path to your base URL.
/matches becomes
https://rugby.highlightly.net/matches with a Rugby API
subscription and
https://sports.highlightly.net/rugby/matches with an
All Sports API subscription. Parameters, responses and refresh
intervals are the same on both, and every endpoint page shows both
routes.
Your plan affects the data retrieved. On the Basic and Free plans highlights may be restricted and some endpoints are not available, with either subscription. See Pagination and limits.
What changes with an All Sports API subscription
The headers have the same names on every base URL.
x-rapidapi-key is sent with every request, and
x-rapidapi-host is sent only when calling through
RapidAPI. What changes is the path and the host header, and on
RapidAPI the key.
| Rugby API | All Sports API | |
|---|---|---|
| Path | /matches |
/rugby/matches |
x-rapidapi-key on Highlightly |
Your Highlightly API key | Your Highlightly API key |
x-rapidapi-key on RapidAPI |
Your Rugby API key | Your All Sports API key |
x-rapidapi-host |
rugby-highlights-api.p.rapidapi.com |
sport-highlights-api.p.rapidapi.com |
On Highlightly, the same API key works on
rugby.highlightly.net and
sports.highlightly.net, and the data returned depends
on your subscription to each product. On RapidAPI, the Rugby API and
the All Sports API are separate products, so each needs its own API
key. One All Sports API quota covers every sport you call. See
All Sports authentication.
Highlightly or RapidAPI
Both platforms give you analytics, billing settings and key management. RapidAPI does not offer custom plans or long term plan discounts.
Create an account at Highlightly or through RapidAPI. Plans and limits are listed on the Rugby API page and the All Sports API page.
OpenAPI specification
Import the OpenAPI 3.0 document into Postman or Insomnia, or generate a client from it.
Download docs.jsonSupport
For feature requests, questions, private plans or business enquiries, contact [email protected]. You can also start a discussion or send a private message through RapidAPI.