Players

Retrieve a list of players.

Refresh interval

15 minutes

Pagination

limit and offset

Detail

General information only

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

This is where player ids come from. Both detail routes are addressed by id, so the usual sequence is to resolve a player here once, store the id, and use the detail routes from then on.

Parameters

Request

curl --request GET \
  --url 'https://soccer.highlightly.net/players?name=Ivan%20Peri%C5%A1i%C4%87' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'Ivan Perišić'
})
const response = await fetch(`https://soccer.highlightly.net/players?${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/players',
    params={
        'name': 'Ivan Perišić',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

Example response

{
  "data": [
    {
      "id": 33481,
      "name": "Ivan Perišić",
      "fullName": "Ivan Perišić",
      "logo": ""
    }
  ],
  "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