---
title: "Get highlight by id"
method: GET
path: "/cricket/highlights/{id}"
tags: ["Cricket.Highlights"]
---

# Get highlight by id

`GET /cricket/highlights/{id}`

## Request

- Base URL: `https://sports.highlightly.net`
- URL: `https://sports.highlightly.net/cricket/highlights/{id}`
- Auth: none declared. Required headers: `x-rapidapi-host`, `x-rapidapi-key`
- TypeScript: <https://skmtc.dev/highlightly/apis/sports-api-highlightly/docs/cricket/highlights/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve highlight information by specifying the highlight id path parameter.

> Note: Used to check whether a highlight still exists or had its information updated.

## Path parameters

- `id` number, required

## Headers

- `x-rapidapi-host` string, required
- `x-rapidapi-key` string, required

## Response `200`

- CricketHighlightResponseDto[]
  - `id` number, required
  - `type` string, required
  - `imgUrl` string: Preview picture of the highlight.
  - `title` string, required
  - `description` string
  - `url` string, required: Url location of the video highlight.
  - `embedUrl` string: Url of embeddable video highlight.
  - `match` CricketMatchResponseDto, required
    - `id` string, required
    - `endDate` string, required
    - `startDate` string, required
    - `startTime` string
    - `country` CricketCountryResponseDto, required
      - `code` string, required: Country code specified by the ISO 3166 standard.
      - `name` string, required
      - `logo` string, required
    - `awayTeam` CricketTeamResponseDto, required
      - `id` string, required
      - `logo` string
      - `name` string, required
      - `abbreviation` string, required
    - `homeTeam` CricketTeamResponseDto, required
      - `id` string, required
      - `logo` string
      - `name` string, required
      - `abbreviation` string, required
    - `league` CricketMatchLeagueResponseDto, required
      - `id` string, required
      - `season` number, required
      - `name` string, required
      - `logo` string
    - `format` string: Cricket match format, e.g. T20, ODI, TEST
    - `dayType` 'SINGLE' | 'MULTI': Information that tells us whether the match will be played across multiple days
    - `state` CricketMatchStateResponseDto, required
      - `description` 'Finished' | 'Unknown' | 'No live coverage' | 'In play' | 'Stumps' | 'Lunch' | 'Innings break' | 'Drinks' | 'Timeout' | 'Tea' | 'Scheduled' | 'Match delayed' | 'Cancelled' | 'Abandoned' | 'Postponed', required: State of the match.
      - `report` string: Descriptive report of the match based on the match status.
      - `teams` CricketMatchScoreTeamsDto, required
        - `away` CricketMatchScoreTeamAwayDto, required
          - `info` string
          - `score` string
        - `home` CricketMatchScoreTeamHomeDto, required
          - `info` string
          - `score` string
  - `channel` string: Channel title of a given highlight.
  - `source` string: Aggregation source from social media and other equivalent platforms.

## Other responses

- `400`: Bad request descriptive error.
- `500`: Internal server error.

---

[API](https://skmtc.dev/highlightly/apis/sports-api-highlightly.md) - [All operations](https://skmtc.dev/highlightly/apis/sports-api-highlightly/llms.txt) - [OpenAPI document](https://skmtc.dev/highlightly/apis/sports-api-highlightly/revisions/c8a366d3091f?raw)