Get geo restrictions for a highlight

Geo restrictions limit access to online content based on where the viewer is. Showing a restricted clip to someone who cannot play it is a poor experience, so check the restrictions before rendering a highlight to a given audience.

Refresh interval

Once an hour

Plan

Not available on Basic/Free

Restriction states

The state field says which rule applies to the highlight, and therefore which of the two country lists you should read.

Both lists hold ISO 3166 two letter country codes, such as IT.

Embedding

Whether the hosting platform permits embedding is a separate question from geography, and embeddable on this response answers it.

The video URLs themselves are not here. embedUrl and url live on the highlight, from highlights or get highlight by ID. So the usual sequence is to read the highlight for its URLs, then read this endpoint to decide whether to frame embedUrl or link out to url.

A highlight can be viewable in a country and still not be embeddable, since embeddable applies to the highlight as a whole.

Parameters

Request

curl --request GET \
  --url 'https://nhl.highlightly.net/highlights/geo-restrictions/{id}' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const response = await fetch('https://nhl.highlightly.net/highlights/geo-restrictions/{id}', {
  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://nhl.highlightly.net/highlights/geo-restrictions/{id}',
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

Example response

{
  "state": "Allowed countries restriction",
  "allowedCountries": [
    "IT"
  ],
  "blockedCountries": [],
  "embeddable": true
}

Values are the examples declared in the OpenAPI spec, not a captured live response.

Errors