Troubleshooting Guide

Whether you're a new developer just starting with Highlightly or an experienced user exploring new endpoints, it's not uncommon to encounter issues that require contacting support. This guide outlines the most frequent mistakes and how to prevent them, helping you save time and integrate more efficiently.

Invalid API key

A common mistake when integrating Highlightly is attempting to send API requests without specifying the required HTTP headers. If you simply copy the API URL and make a request without the appropriate headers, you will receive one of the following errors depending on which endpoint you're using. For RapidAPI the error would be:

          
{
    "message": "Invalid API key. Go to https://docs.rapidapi.com/docs/keys for more info."
}
          
        

As for Highlightly, you can expect the following message:

          
{
    "status": 403,
    "error": "Missing mandatory HTTP Headers. Please visit https://highlightly.net/ documentation for more information",
}
          
        

To resolve this, make sure you include the following HTTP headers in every request:

• x-rapidapi-key: Your API token obtained from RapidAPI or Highlightly.
• x-rapidapi-host: The host corresponding to the API you're calling (e.g., sport-highlights-api.p.rapidapi.com for Sport Highlights API).

Using the wrong platform URL

Highlightly offers two ways to access the APIs. One is via RapidAPI and the other one is through the Highlightly platform. While both provide access to the same data, the authentication is completely separate. Accounts and API tokens are not cross-compatible. If you created an account on Highlightly and used the RapidAPI base URL, you will receive the following error:

          
{
    "message": "You are not subscribed to this API."
}
          
        

The same goes if you created an account on RapidAPI and used Highlightly base URL:

          
{
    "message": "Invalid request token.",
    "error": "Unauthorized",
    "statusCode": 401
}
          
        

The solution to this problem is quite simple, ensure that you are using the correct base URL, e.g. for Highlightly Sport API:

• RapidAPI base URL: https://sport-highlights-api.p.rapidapi.com
• Highlightly base URL: https://sports.highlightly.net

Invalid HTTP host header

When using Highlightly via RapidAPI, one of the required HTTP headers is x-rapidapi-host. Since there are multiple Highlightly APIs, there exists a scenario where you can send the wrong header value. If you make that mistake, you will receive the following error message:

          
{
    "messages": "The host you've provided is invalid. If you have difficulties, contact the RapidAPI support team, [email protected]"
}
          
        

To resolve the issue check the API documentation for the specific x-rapidapi-host value required. For Highlightly's Sports API the header value should be sport-highlights-api.p.rapidapi.com.

Breached daily quota

One common issue users face is exceeding their daily API request limits. Depending on the platform you're using, the error message will differ. If you are sending requests through RapidAPI you will receive:

          
{
    "message": "You have exceeded the DAILY quota for Requests on your current plan, BASIC. Upgrade your plan at https:\/\/rapidapi.com\/highlightly-api-highlightly-api-default\/api\/sport-highlights-api"
}
          
        

As for Highlightly, the error would be:

          
{
    "message": "You have breached your daily request limits."
}
          
        

The issue can be resolved by:

• Monitoring and managing your request volumes closely.
• Consider upgrading to a higher tier plan or requesting a custom quota if needed.
• Contacting Highlightly support for assistance if the breach was unexpected or due to abnormal usage.
• Ensuring your API token hasn't been exposed publicly. Rotate it if there's any suspicion of misuse.

At least one parameter should be defined

Almost all routes have certain restrictions in place. One of them would be the "query parameter" restriction where you need to specify at least one data constraining query parameter. If you do not, you will receive the following error:

          
{
    "message": "At least one param has to be defined",
    "statusCode": 400
}
          
        

It should be noted that limit, offset and timezone are NOT considered data constraining parameters. Check the documentation for possible query parameters for every endpoint.

Extremely slow responses through RapidAPI

Depending on where you registered, your API requests are either sent directly to Highlightly's servers or routed through RapidAPI's proxy. In some cases, proxying via RapidAPI can introduce noticeable latency, negatively affecting user experience.

Accounts are not cross-platform compatible. If you signed up via RapidAPI, you cannot use that API token with Highlightly's direct API URL, and vice versa.

If response speed is a concern, consider registering directly on Highlightly to avoid proxy related delays. Direct access offers better performance and lower response times.

Not getting the data for your timezone

By default, all Highlightly API responses use the Etc/UTC timezone. If you want to localize the data to your users' region, you must explicitly pass the timezone parameter in all requests that accept a date parameter. If an invalid timezone is provided, you may encounter the following response:

          
{
    "message": "Provided timezone is invalid.",
    "statusCode": 400
}
          
        

Ensure you're using a valid IANA timezone name (e.g., America/New_York, Europe/London).

Wrap up

The above examples cover the most common issues users encounter when working with the Highlightly API. Of course, there may be other problems that arise on a case-by-case basis. Some issues could stem from incorrect API usage, while others might result from unexpected behavior or bugs on our end. If you ever find yourself stuck or suspect something isn’t working as intended, don’t hesitate to reach out to our support team. We are always ready to help.