# 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
- **Stats:** 8 total users, 2 monthly users, 100.0% runs succeeded, 0 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/platform/actors/running/actors-in-store#pay-per-event
## What's an Apify Actor?
Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
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.
Actors are written with capital "A".
## 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.
The best way to integrate Actors is as follows.
In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):
```bash
npm install apify-client
```
In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):
```bash
pip install apify-client
```
In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):
````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash
In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).
If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).
For usage examples, see the [API](#api) section below.
For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).
# 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": "Sign up",
"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 '' with your token
const client = new ApifyClient({
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 '' with your token.
client = ApifyClient("")
# 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("πΎ Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).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": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=hanamira/axe-accessibility-tester",
"--header",
"Authorization: Bearer "
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "Axe Accessibility Tester",
"description": "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.",
"version": "0.0",
"x-build-id": "xaoCRju5XBSITXxVB"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/hanamira~axe-accessibility-tester/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-hanamira-axe-accessibility-tester",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/hanamira~axe-accessibility-tester/runs": {
"post": {
"operationId": "runs-sync-hanamira-axe-accessibility-tester",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/hanamira~axe-accessibility-tester/run-sync": {
"post": {
"operationId": "run-sync-hanamira-axe-accessibility-tester",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"required": [
"urls"
],
"properties": {
"urls": {
"title": "URLs to Test",
"type": "array",
"description": "List of URLs to test for accessibility issues.",
"items": {
"type": "string"
}
},
"crawl": {
"title": "Crawl Website",
"type": "boolean",
"description": "If enabled, crawl the website and test all discovered pages (up to maxPages).",
"default": false
},
"maxPages": {
"title": "Max Pages to Test",
"minimum": 1,
"maximum": 100,
"type": "integer",
"description": "Maximum number of pages to test when crawling is enabled.",
"default": 10
},
"wcagLevel": {
"title": "WCAG Conformance Level",
"enum": [
"wcag2a",
"wcag2aa",
"wcag2aaa",
"wcag21a",
"wcag21aa",
"wcag21aaa",
"wcag22aa"
],
"type": "string",
"description": "WCAG conformance level to test against.",
"default": "wcag21aa"
},
"includeWarnings": {
"title": "Include Warnings",
"type": "boolean",
"description": "Include 'needs review' items that require manual verification.",
"default": true
},
"includePasses": {
"title": "Include Passed Tests",
"type": "boolean",
"description": "Include tests that passed (can make output very large).",
"default": false
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}
```