{
"url": "https://example.com/",
"finalUrl": "https://example.com/",
"statusCode": 200,
"hreflangFound": false,
"grade": "A+",
"score": 99,
"summary": {
"errors": 0,
"warnings": 0,
"infos": 1
},
"issues": [
{
"severity": "info",
"code": "no_hreflang",
"message": "No hreflang annotations were found in the HTML <head> or the Link header. That is fine for a single-language site; multilingual sites should declare every language version. Basis: Google Search Central, \"Tell Google about localized versions of your page\".",
"docs": "https://developers.google.com/search/docs/specialty/international/localized-versions"
}
],
"omittedIssues": 0,
"annotations": [],
"annotationCount": 0,
"selfReference": {
"found": false,
"hreflang": []
},
"xDefault": null,
"canonical": null,
"returnLinks": null,
"cached": false,
"checkedAt": "2026-10-21T02:00:54.694Z",
"note": "Checks the hreflang annotations a page declares in its HTML <head> and Link response header, and fetches up to maxAlternates alternate URLs (without following their redirects) to verify return links. XML sitemap annotations are not read, JavaScript is not rendered, and the result does not show which version Google actually serves in search results."
}
curl --location --request GET 'https://zylalabs.com/api/14381/hreflang+validator+api/36043/validate+the+hreflang+annotations+of+a+live+page?url=https://example.com&maxAlternates=10' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Hreflang Validator API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
Checks a web page's hreflang annotations against Google's documented rules and verifies that up to 10 alternates link back. Returns one graded JSON report with stable issue codes.
Language and region codes, self-reference, x-default, conflicting or duplicate annotations, relative URLs, canonical conflicts and whether up to 10 alternates link back. It returns a grade, a score and coded issues.
At most 10 per page, the first 10 in declaration order. When a page lists more, returnLinks.partial is true and the grade covers only the alternates actually checked.
No. Only link tags in the HTML head and the Link response header are read. A page that declares hreflang only in a sitemap is reported as having no hreflang.
Yes. A bare domain such as example.com is treated as https. Parameter aliases such as u, link, target and site are accepted as well.
Gate on the errors count in the summary rather than the letter grade alone. Add the fresh parameter set to 1 to bypass the 15 minute cache right after a deploy.
The API returns a graded JSON report that includes the URL checked, status code, hreflang findings, a summary of issues, and detailed information about any errors or warnings related to hreflang annotations.
Key fields include "url" (the checked URL), "statusCode" (HTTP response code), "grade" (overall assessment), "summary" (counts of errors, warnings, and info), and "issues" (detailed descriptions of any problems found).
The response is structured in JSON format, with top-level fields for the URL, status, grade, summary, and issues. Each issue includes severity, code, message, and documentation links for further reference.
The API provides information on hreflang annotations, including their presence, correctness, self-references, x-default settings, and whether alternates link back correctly, along with a grading system for assessment.
Users can customize requests by specifying the URL to validate. They can also control the number of alternates checked by adjusting the maxAlternates parameter, though the default is set to 10.
Typical use cases include validating hreflang annotations for multilingual websites, ensuring proper SEO practices, and identifying issues that could affect search engine indexing and user experience across different regions.
Users can analyze the "grade" and "summary" fields to assess overall hreflang implementation quality. The "issues" array provides actionable insights for fixing specific problems, enhancing site localization efforts.
Data accuracy is maintained by adhering to Google's documented rules for hreflang annotations. The API checks for compliance with these standards and provides stable issue codes to ensure consistent reporting.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund