# Axe Accessibility Tester (`hanamira/axe-accessibility-tester`) Actor

Test any website for WCAG accessibility issues using axe-core. Scan single pages or crawl entire sites. Get detailed reports with violation severity, affected elements, and remediation guidance. Supports WCAG 2.0, 2.1, and 2.2 at A, AA, and AAA levels.

- **URL**: https://apify.com/hanamira/axe-accessibility-tester.md
- **Developed by:** [hannah mira](https://apify.com/hanamira) (community)
- **Categories:** Automation, Developer tools, SEO tools
- **Features:** Limited permissions
- **Stats:** 11 total users, 0 monthly users, 100.0% runs succeeded, 1 bookmarks
- **User rating**: No ratings yet

## Pricing

from $10.00 / 1,000 results

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

## Axe Accessibility Tester

Automatically audit any website for WCAG accessibility compliance using the industry-standard axe-core engine. Identify barriers that prevent users with disabilities from accessing your content.

### What it does

- Scans single pages or crawls entire websites
- Tests against WCAG 2.0, 2.1, and 2.2 standards (A, AA, AAA levels)
- Reports violations with severity ratings (critical, serious, moderate, minor)
- Provides specific remediation guidance for each issue
- Pinpoints exact HTML elements causing failures

### Use cases

- **QA teams**: Catch accessibility regressions before deployment
- **Agencies**: Audit client websites for ADA/Section 508 compliance
- **Developers**: Integrate accessibility checks into CI/CD pipelines
- **Consultants**: Generate detailed reports for accessibility remediation projects

### Input

| Field | Type | Description | Default |
|-------|------|-------------|---------|
| `urls` | array | URLs to test for accessibility | Required |
| `crawl` | boolean | Crawl and test linked pages | `false` |
| `maxPages` | number | Maximum pages to test when crawling | `10` |
| `wcagLevel` | string | WCAG conformance level to test | `wcag21aa` |
| `includeWarnings` | boolean | Include items needing manual review | `true` |
| `includePasses` | boolean | Include passed checks in output | `false` |

### Output

Each result includes:

- **url**: The tested page URL
- **violationsCount**: Total number of violations found
- **warningsCount**: Items requiring manual review
- **passesCount**: Number of passed checks
- **severityCounts**: Breakdown by critical, serious, moderate, minor
- **violations**: Detailed list with affected elements, selectors, and fix guidance

#### Example output

```json
{
  "url": "https://github.com/",
  "wcagLevel": "wcag21aa",
  "testedAt": "2025-12-08T00:10:00.000Z",
  "violationsCount": 2,
  "warningsCount": 5,
  "passesCount": 42,
  "severityCounts": {
    "critical": 0,
    "serious": 1,
    "moderate": 1,
    "minor": 0
  },
  "violations": [
    {
      "id": "color-contrast",
      "impact": "serious",
      "description": "Elements must meet minimum color contrast ratio thresholds",
      "help": "Elements must have sufficient color contrast",
      "helpUrl": "https://dequeuniversity.com/rules/axe/4.10/color-contrast",
      "nodes": [
        {
          "html": "<span class=\"text-muted\">Sign up</span>",
          "target": [".signup-btn > span"],
          "failureSummary": "Fix any of the following: Element has insufficient color contrast of 3.5:1 (foreground: #8b949e, background: #ffffff). Expected contrast ratio of 4.5:1"
        }
      ]
    }
  ]
}
```

### Why axe-core?

axe-core is trusted by Microsoft, Google, and government agencies. It powers accessibility testing in Chrome DevTools and catches issues that other tools miss—with zero false positives guaranteed.

# Actor input Schema

## `urls` (type: `array`):

List of URLs to test for accessibility issues.

## `crawl` (type: `boolean`):

If enabled, crawl the website and test all discovered pages (up to maxPages).

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

Maximum number of pages to test when crawling is enabled.

## `wcagLevel` (type: `string`):

WCAG conformance level to test against.

## `includeWarnings` (type: `boolean`):

Include 'needs review' items that require manual verification.

## `includePasses` (type: `boolean`):

Include tests that passed (can make output very large).

## Actor input object example

```json
{
  "urls": [
    "https://github.com/"
  ],
  "crawl": false,
  "maxPages": 10,
  "wcagLevel": "wcag21aa",
  "includeWarnings": true,
  "includePasses": false
}
```

# Actor output Schema

## `results` (type: `string`):

No description

## `summary` (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 = {
    "urls": [
        "https://github.com/"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("hanamira/axe-accessibility-tester").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 = { "urls": ["https://github.com/"] }

# Run the Actor and wait for it to finish
run = client.actor("hanamira/axe-accessibility-tester").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 '{
  "urls": [
    "https://github.com/"
  ]
}' |
apify call hanamira/axe-accessibility-tester --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,hanamira/axe-accessibility-tester"
        }
    }
}
```

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/wDBel9Hb2FTDtkil8/builds/xaoCRju5XBSITXxVB/openapi.json