---
title: "Get head 2 head games"
method: GET
path: "/nhl/head-2-head"
tags: ["NHL, NCAAH.Head 2 Head"]
---

# Get head 2 head games

`GET /nhl/head-2-head`

## Request

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

Retrieve a list of the **last ten** head 2 head games between two teams. Compare the two teams to find out who is stronger based on their past match results. 

Specify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.

Below is an example of what you can achieve with the data:

![H2H example](https://highlightly.net/assets/img/documentation/nhl/h2h.png)

## Query parameters

- `teamIdOne` number, required
- `teamIdTwo` number, required

## Headers

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

## Response `200`

- NhlMatchResponseDto[]
  - `id` number, required
  - `round` string, required
  - `date` string, required
  - `league` string, required
  - `season` number, required
  - `awayTeam` NhlMatchTeamResponseDto, required
    - `id` number, required
    - `logo` string
    - `name` string
    - `displayName` string, required
    - `abbreviation` string, required
  - `homeTeam` NhlMatchTeamResponseDto, required
    - `id` number, required
    - `logo` string
    - `name` string
    - `displayName` string, required
    - `abbreviation` string, required
  - `state` NhlMatchStateResponseDto, 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` NhlMatchScoreResponseDto, 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.
      - `overtimePeriod` string: Home - Away score in the overtime period.
    - `report` string: Additional description of the match state.

## 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)