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

# Get highlight by id

`GET /hockey/highlights/{id}`

## Request

- Base URL: `https://sports.highlightly.net`
- URL: `https://sports.highlightly.net/hockey/highlights/{id}`
- Auth: none declared. Required headers: `x-rapidapi-host`, `x-rapidapi-key`
- TypeScript: <https://skmtc.dev/highlightly/apis/sports-api-highlightly/docs/hockey/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`

- HockeyHighlightResponseDto[]
  - `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` HockeyMatchResponseDto, required
    - `id` number, required
    - `week` string
    - `date` string, required
    - `country` HockeyCountryResponseDto, required
      - `code` string, required: Country code specified by the ISO 3166 standard.
      - `name` string, required
      - `logo` string, required
    - `awayTeam` HockeyTeamResponseDto, required
      - `id` number, required
      - `logo` string
      - `name` string, required
    - `homeTeam` HockeyTeamResponseDto, required
      - `id` number, required
      - `logo` string
      - `name` string, required
    - `league` HockeyMatchLeagueResponseDto, required
      - `id` number, required
      - `season` number, required
      - `name` string, required
      - `logo` string
    - `state` HockeyMatchStateResponseDto, required
      - `description` 'Not started' | '1st period' | '2nd period' | '3rd period' | 'Over time' | 'Penalties' | 'Break time' | 'Awarded' | 'Postponed' | 'Cancelled' | 'Interrupted' | 'Abandoned' | 'Finished' | 'To be announced' | 'Finished after penalties' | 'Finished after over time' | 'Unknown', required: Current state of the game.
      - `score` HockeyMatchScoreResponseDto, required
        - `current` string: Home - Away score for the match.
        - `overTime` string: Home - Away score in overtime.
        - `penalties` string: Home - Away score in penalties.
        - `firstPeriod` string: Home - Away score in 1st period.
        - `secondPeriod` string: Home - Away score in 2nd period.
        - `thirdPeriod` string: Home - Away score in 3rd period.
  - `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)