Teams
Retrieve the teams supported by the API.
- Pagination
- limit and offset, 500 per page
Use the name query parameter to check whether a specific team is supported,
or to fetch just its record rather than the whole list.
Each team carries an id and a name, and may carry a
logo URL.
The id is the value other endpoints expect. It filters
matches as homeTeamId or
awayTeamId, and is the required parameter on
team statistics,
last five games and
head to head.
Parameters
| Parameter | Type | Description |
|---|---|---|
limitoptional |
numberdefault 500
|
No description in the spec.e.g. 50
|
offsetoptional |
numberdefault 0
|
No description in the spec.e.g. 0
|
nameoptional |
string |
No description in the spec.e.g. Solingen W
|
Request
curl --request GET \
--url 'https://handball.highlightly.net/teams?name=Solingen%20W' \
--header 'x-rapidapi-key: YOUR_API_KEY'
const params = new URLSearchParams({
name: 'Solingen W'
})
const response = await fetch(`https://handball.highlightly.net/teams?${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://handball.highlightly.net/teams',
params={
'name': 'Solingen W',
},
headers={
'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
},
timeout=10,
)
response.raise_for_status()
data = response.json()
Response
dataHandballTeamResponse[]required3 fields
idnumberrequired
logostring
namestringrequired
paginationPaginationResponserequired3 fields
totalCountnumberrequiredAvailable number of items, relevant to the provided query.
offsetnumberrequired
limitnumberrequired
planPlanResponserequired2 fields
tierstringrequiredYour current API subscription tier.
messagestringrequiredExplanation message regarding your current tier.
Example response
{
"data": [
{
"id": 332674,
"logo": "https://example.com/logos/team/332674.png",
"name": "Solingen W"
}
],
"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
| Status | Description |
|---|---|
400 |
Bad request descriptive error. |
500 |
Internal server error. |