# Find the broken links on a website

**Use case:** 

Crawls a site and reports every link that does not resolve, with the real HTTP status code behind it. A 403 is reported as blocked and a 429 as rate-limited rather than being counted as dead, so the list you get back is the list that is actually broken.

## Input

```json
{
  "startUrls": [
    {
      "url": "https://example.com"
    }
  ],
  "maxPages": 25,
  "checkExternal": true,
  "onlyBroken": true,
  "useProxy": false,
  "maxConcurrency": 10,
  "maxItems": 100000
}
```

## Output

```json
{
  "sourcePage": {
    "label": "Source Page",
    "format": "string"
  },
  "url": {
    "label": "Url",
    "format": "string"
  },
  "anchorText": {
    "label": "Anchor Text",
    "format": "string"
  },
  "internal": {
    "label": "Internal",
    "format": "boolean"
  },
  "state": {
    "label": "State",
    "format": "string"
  },
  "httpStatus": {
    "label": "Http Status",
    "format": "integer"
  },
  "reason": {
    "label": "Reason",
    "format": "string"
  },
  "finalUrl": {
    "label": "Final Url",
    "format": "string"
  }
}
```

## How it works

### 1. Sign up on Apify or log in

The Broken Link Checker — Honest Link Health Actor is ready to run with the inputs already set for "Find the broken links on a website". [Sign up or log in](https://console.apify.com/create-task-from-example/Kl86e73FSpN5PcrUw) and you'll land in Apify Console with a copy of this exact task.

### 2. Start the "Find the broken links on a website" task

The Broken Link Checker — Honest Link Health Actor will start running based on the input automatically. You can also change all the input fields, like start urls, pages to crawl, and more, to match your specific use case.

### 3. Receive the "Find the broken links on a website" output

Monitor the progress in real time. You will be notified as soon as your dataset is complete and ready for review. Each result includes data such as source page, url, anchor text, and more.

### 4. Integrate into your workflow

The final output is delivered in JSON, CSV, or Excel format, ready to be plugged into your workflow. You can also [run the "Find the broken links on a website" task via API](https://apify.com/alaudinburki/broken-link-checker.md).

## About this Actor

This example demonstrates how to use [Broken Link Checker — Honest Link Health](https://apify.com/alaudinburki/broken-link-checker.md) with a specific input configuration. Visit the [Actor detail page](https://apify.com/alaudinburki/broken-link-checker.md) to learn more, explore other use cases, and run it yourself.


## How to integrate an Actor?

This Task's input is already configured above. Use it as-is rather than inventing a new one.

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 full API examples (JavaScript, Python, CLI, MCP, OpenAPI), see this Task's Actor page: https://apify.com/alaudinburki/broken-link-checker.md

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`).
