---
title: "Get highlight by id"
method: GET
path: "/american-football/highlights/{id}"
tags: ["American Football.Highlights"]
---

# Get highlight by id

`GET /american-football/highlights/{id}`

## Request

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

- AmericanFootballHighlightResponseDto[]
  - `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` AmericanFootballMatchResponseDto, required
    - `id` number, required
    - `round` string, required
    - `date` string, required
    - `league` string, required
    - `season` number, required
    - `awayTeam` AmericanFootballMatchTeamResponseDto, required
      - `id` number, required
      - `logo` string
      - `name` string
      - `displayName` string, required
      - `abbreviation` string, required
    - `homeTeam` AmericanFootballMatchTeamResponseDto, required
      - `id` number, required
      - `logo` string
      - `name` string
      - `displayName` string, required
      - `abbreviation` string, required
    - `state` AmericanFootballMatchStateResponseDto, required
      - `period` number: Current in play period.
      - `clock` number: Current minute of the in play period.
      - `description` 'Suspended' | 'Postponed' | 'Cancelled' | 'Abandoned' | 'Finished' | 'In progress' | 'End period' | 'Half time' | 'Unknown' | 'Scheduled', required: Current status/description of the match.
      - `score` AmericanFootballMatchScoreResponseDto, required
        - `current` string: Home - Away score for the match.
        - `firstPeriod` string: Home - Away score in 1st period.
        - `secondPeriod` string: Home - Away score in 2nd period.
        - `thirdPeriod` string: Home - Away score in 3rd period.
        - `fourthPeriod` string: Home - Away score in 4th period.
        - `firstOvertimePeriod` string: Home - Away score in the first overtime period.
        - `secondOvertimePeriod` string: Home - Away score in the second overtime period.
      - `report` string: Additional description of the match state.
  - `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)