Cricket API / players

Players

GET https://cricket.highlightly.net/players Cricket API
GET https://sports.highlightly.net/cricket/players All Sports API

Retrieve a list of players.

Refresh interval
Once a day
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.

What each record carries

Field Contains
ID Unique identifier of the player.
Long name Full name of the player.
Gender Gender of the player.
Date of birth A Unix timestamp in milliseconds.
Batting styles Short form codes such as rhb and lhb.
Bowling styles Short form bowling style codes.
Long batting styles Readable descriptions of those batting styles.
Long bowling styles Readable descriptions of those bowling styles.
Teams Teams the player has been associated with, each with id, abbreviation, logo and isCurrent.

Parameters

Parameter Type Description
nameoptional string No description in the spec.e.g. Virat Kohli
limitoptional numberdefault 1000 No description in the spec.e.g. 1000
offsetoptional numberdefault 0 No description in the spec.e.g. 0
teamIdoptional number No description in the spec.e.g. 422

Request

curl --request GET \
  --url 'https://cricket.highlightly.net/players?name=Virat%20Kohli&teamId=422' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const params = new URLSearchParams({
  name: 'Virat Kohli',
  teamId: '422'
})
const response = await fetch(`https://cricket.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://cricket.highlightly.net/players',
    params={
        'name': 'Virat Kohli',
        'teamId': '422',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

dataSinglePlayerInfoResponseMD[]required13 fields
idstringrequired
longNamestringrequired
genderstring
dateOfBirthnumberPlayer birth date in Unix timestamp
battingStylesstring[]required
bowlingStylesstring[]required
longBattingStylesstring[]required
longBowlingStylesstring[]required
teamsPlayerTeamResponseMD[]4 fields
idnumberrequired
abbreviationstringrequired
logostringrequired
isCurrentbooleanrequired
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

200 application/json 
{
  "data": [
    {
      "id": "ee38c051-470a-4f80-93e5-a034fc6f0ce2",
      "longName": "Virat Kohli",
      "gender": "M",
      "dateOfBirth": 594691200000,
      "battingStyles": [
        "rhb"
      ],
      "bowlingStyles": [
        "rm"
      ],
      "longBattingStyles": [
        "right-hand bat"
      ],
      "longBowlingStyles": [
        "right-hand bat"
      ],
      "teams": [
        {
          "id": 1,
          "abbreviation": "RCB",
          "logo": "https://highlightly.net/cricket/images/teams/1.png",
          "isCurrent": true
        }
      ]
    }
  ],
  "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.