# Hreflang Cluster & Return-Link Auditor (`umararshad2/hreflang-cluster-return-link-auditor`) Actor

Audit hreflang clusters across localized pages. Detect invalid language or region codes, missing self-references, broken reciprocal return links, duplicate alternates, canonical or noindex conflicts, redirects, and x-default gaps.

- **URL**: https://apify.com/umararshad2/hreflang-cluster-return-link-auditor.md
- **Developed by:** [Umar Arshad](https://apify.com/umararshad2) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.50 / 1,000 page audits

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Hreflang Cluster & Return-Link Auditor

Audit multilingual and multi-regional page clusters for the implementation rules that commonly break international SEO. Start from one or more public localized pages; the Actor can follow declared alternates and verify reciprocal return links across the fetched cluster.

### What it checks

- hreflang annotations in the HTML `<head>`
- supported language, script, region, and `x-default` syntax
- self-referencing annotations
- reciprocal return links between fetched localized variants
- duplicate language-region targets
- absolute alternate URLs
- canonicals pointing away from localized pages
- `noindex` directives, redirects, and HTML language hints

Each successfully fetched page produces one filterable dataset record with a 0–100 score, blocking errors, warnings, missing return-link targets, and practical fixes.

### Input and limits

Provide 1–10 public HTTP(S) starting pages. With alternate discovery enabled, the Actor follows declared alternate URLs up to a maximum of 50 successfully fetched pages. Every URL and redirect is checked against public-network rules. Credential-bearing, private, local, special-use, and unsafe-DNS destinations are rejected. Responses are limited to 2 MB, 15 seconds, and five redirects.

```json
{
  "startUrls": [{ "url": "https://www.example.com/en/product" }],
  "followAlternates": true,
  "maxPages": 20
}
```

### Output

Every successful page audit includes the requested and final URL, HTTP status, title, HTML language, canonical, normalized alternates, self-reference and `x-default` flags, missing reciprocal links, score, verdict, errors, warnings, fixes, and audit timestamp.

### Honest scope

This Actor performs deterministic checks against public HTML. It does not access Google Search Console, prove that Google indexed a page, detect page language from rendered text, or guarantee rankings or correct regional search selection. It checks HTML annotations, not hreflang supplied only through XML sitemaps or HTTP headers. JavaScript-injected tags absent from returned HTML may not be detected.

### Pricing intent

Current Store price: **$1.50 per 1,000 successfully fetched page audits** plus a minimal Actor-start event, with platform usage included. Failed fetches are logged but are not written as billable audit results.

# Actor input Schema

## `startUrls` (type: `array`):

Add one or more public localized pages. The Actor can follow their declared hreflang alternates to verify the complete cluster.

## `followAlternates` (type: `boolean`):

Fetch declared hreflang targets to verify reciprocal return links. Discovery stops at the page limit.

## `maxPages` (type: `integer`):

Maximum successfully fetched pages per run, including discovered alternates.

## Actor input object example

```json
{
  "startUrls": [
    {
      "url": "https://www.apple.com/"
    }
  ],
  "followAlternates": true,
  "maxPages": 20
}
```

# Actor output Schema

## `dataset` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "startUrls": [
        {
            "url": "https://www.apple.com/"
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("umararshad2/hreflang-cluster-return-link-auditor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "startUrls": [{ "url": "https://www.apple.com/" }] }

# Run the Actor and wait for it to finish
run = client.actor("umararshad2/hreflang-cluster-return-link-auditor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "startUrls": [
    {
      "url": "https://www.apple.com/"
    }
  ]
}' |
apify call umararshad2/hreflang-cluster-return-link-auditor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,umararshad2/hreflang-cluster-return-link-auditor"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/CmHG1VevadbToJvB7/builds/ADJSb7zrRkKaXDnL0/openapi.json
