# WCAG Accessibility Checker API | ADA & EAA Compliance Audit (`taroyamada/wcag-accessibility-checker`) Actor Audit websites for WCAG 2.1 accessibility compliance in bulk. Get A-F grades, violation details with severity, and actionable remediation steps per URL. - **URL**: https://apify.com/taroyamada/wcag-accessibility-checker.md - **Developed by:** [åĪŠéƒŽ åąąį”°](https://apify.com/taroyamada) (community) - **Categories:** Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $15.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 ## WCAG Accessibility Checker API | ADA & EAA Compliance Audit Audit websites for **WCAG 2.1** accessibility compliance. Get A-F grades, violation details by severity, and actionable remediation steps per URL. ### Quickstart 1. Add URLs to audit 2. Select WCAG level (A, AA, or AAA) 3. Run the actor 4. Get grades + violations + fix recommendations in the dataset ### Who Gets Value Fastest | Role | Use Case | |------|----------| | **Compliance teams** | Weekly ADA/EAA compliance monitoring with change alerts | | **Web agencies** | Bulk audit client portfolios, report accessibility grades | | **Government contractors** | Section 508 compliance verification | | **Enterprise IT** | Pre-deployment accessibility gates | | **QA teams** | Automated accessibility regression testing | ### What Does This Actor Do? For each URL, the actor: 1. Opens the page in a real browser (Playwright + Chromium) 2. Runs the industry-standard **axe-core** accessibility engine 3. Evaluates against your chosen WCAG level (A, AA, or AAA) 4. Scores the page 0-100 with an A-F grade 5. Lists every violation with severity, affected elements, and WCAG criteria 6. Generates prioritized remediation actions 7. Detects score/grade changes from previous runs (recurring monitoring) ### WCAG Levels | Level | Description | Common Requirement | |-------|-------------|--------------------| | **A** | Minimum accessibility | Basic compliance | | **AA** | Standard accessibility | ADA (US), EAA (EU), most legal requirements | | **AAA** | Maximum accessibility | Strictest, often aspirational | ### Scoring Method - Starts at **100 points** - Each violation node deducts points by severity: - Critical: -8 per affected element - Serious: -5 per affected element - Moderate: -3 per affected element - Minor: -1 per affected element - **A** = 85-100, **B** = 70-84, **C** = 50-69, **D** = 30-49, **F** = 0-29 ### Output Per URL ```json { "url": "https://example.com", "score": { "total": 78, "grade": "B", "level": "AA" }, "summary": { "violations": 4, "critical": 1, "serious": 2, "moderate": 1, "minor": 0, "passes": 45, "incomplete": 3 }, "violations": [ { "id": "image-alt", "impact": "critical", "description": "Images must have alternate text", "helpUrl": "https://dequeuniversity.com/rules/axe/4.x/image-alt", "nodeCount": 3, "wcagCriteria": ["1.1.1"] } ], "recommendedActions": [ "[CRITICAL] Images must have alternate text (3 elements)", "[SERIOUS] Elements must meet minimum color contrast ratio requirements (2 elements)" ] } ```` ### Recurring Monitoring Set up a scheduled task for weekly or monthly compliance checks. The actor tracks grade and score changes between runs, so you get alerts when accessibility regresses. ### Related Audit Suite - **Security Headers Checker** - OWASP security header audit - **Site Governance Monitor** - robots.txt, sitemap, schema.org - **Schema.org Validator** - structured data validation - **SSL Certificate Monitor** - certificate expiry and security ### Input Reference | Field | Type | Default | Description | |-------|------|---------|-------------| | `urls` | array | (required) | URLs to audit, max 50 | | `wcagLevel` | string | `"AA"` | WCAG level: A, AA, or AAA | | `includeWarnings` | boolean | `true` | Include best-practice warnings | | `concurrency` | integer | `2` | Parallel browser tabs (1-5) | | `delivery` | string | `"dataset"` | Output: dataset or webhook | | `webhookUrl` | string | | Webhook endpoint URL | | `waitForSelector` | string | | CSS selector to wait for (SPAs) | | `timeout` | integer | `30000` | Page load timeout (ms) | | `dryRun` | boolean | `false` | Test mode, no output saved | ### Powered By - [axe-core](https://github.com/dequelabs/axe-core) by Deque Systems - the industry standard for automated accessibility testing - [Playwright](https://playwright.dev/) - reliable browser automation # Actor input Schema ## `urls` (type: `array`): List of URLs to audit for WCAG accessibility compliance. Maximum 50 per run. ## `wcagLevel` (type: `string`): WCAG conformance level to check against. AA is the most common legal requirement (ADA, EAA). AAA is the strictest. ## `includeWarnings` (type: `boolean`): Include incomplete checks that need manual review, in addition to definite violations. ## `delivery` (type: `string`): How to deliver results. 'dataset' saves to Apify Dataset, 'webhook' sends to a URL. ## `webhookUrl` (type: `string`): Webhook URL to send results to (only used when delivery is 'webhook'). Works with Slack, Discord, or any HTTP endpoint. ## `snapshotKey` (type: `string`): Key name for storing snapshots (used for change detection between runs). ## `concurrency` (type: `integer`): Parallel browser tabs. Higher = faster but uses more memory. Keep at 2-3 for most cases. ## `waitForSelector` (type: `string`): Optional CSS selector to wait for before auditing. Useful for SPAs that load content dynamically. ## `timeout` (type: `integer`): Maximum time to wait for page load in milliseconds. ## `dryRun` (type: `boolean`): If true, runs without saving results or sending webhooks. Useful for testing. ## Actor input object example ```json { "urls": [ "https://example.com", "https://www.w3.org" ], "wcagLevel": "AA", "includeWarnings": true, "delivery": "dataset", "snapshotKey": "wcag-accessibility-snapshots", "concurrency": 2, "timeout": 30000, "dryRun": false } ``` # 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://example.com", "https://www.w3.org" ] }; // Run the Actor and wait for it to finish const run = await client.actor("taroyamada/wcag-accessibility-checker").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://example.com", "https://www.w3.org", ] } # Run the Actor and wait for it to finish run = client.actor("taroyamada/wcag-accessibility-checker").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://example.com", "https://www.w3.org" ] }' | apify call taroyamada/wcag-accessibility-checker --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=taroyamada/wcag-accessibility-checker", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "WCAG Accessibility Checker API | ADA & EAA Compliance Audit", "description": "Audit websites for WCAG 2.1 accessibility compliance in bulk. Get A-F grades, violation details with severity, and actionable remediation steps per URL.", "version": "0.1", "x-build-id": "kh1khZ22XH1UFYvq3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~wcag-accessibility-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-wcag-accessibility-checker", "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/taroyamada~wcag-accessibility-checker/runs": { "post": { "operationId": "runs-sync-taroyamada-wcag-accessibility-checker", "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/taroyamada~wcag-accessibility-checker/run-sync": { "post": { "operationId": "run-sync-taroyamada-wcag-accessibility-checker", "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 Audit", "type": "array", "description": "List of URLs to audit for WCAG accessibility compliance. Maximum 50 per run.", "items": { "type": "string" } }, "wcagLevel": { "title": "WCAG Conformance Level", "enum": [ "A", "AA", "AAA" ], "type": "string", "description": "WCAG conformance level to check against. AA is the most common legal requirement (ADA, EAA). AAA is the strictest.", "default": "AA" }, "includeWarnings": { "title": "Include Warnings", "type": "boolean", "description": "Include incomplete checks that need manual review, in addition to definite violations.", "default": true }, "delivery": { "title": "Delivery Mode", "enum": [ "dataset", "webhook" ], "type": "string", "description": "How to deliver results. 'dataset' saves to Apify Dataset, 'webhook' sends to a URL.", "default": "dataset" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Webhook URL to send results to (only used when delivery is 'webhook'). Works with Slack, Discord, or any HTTP endpoint." }, "snapshotKey": { "title": "Snapshot Key", "type": "string", "description": "Key name for storing snapshots (used for change detection between runs).", "default": "wcag-accessibility-snapshots" }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Parallel browser tabs. Higher = faster but uses more memory. Keep at 2-3 for most cases.", "default": 2 }, "waitForSelector": { "title": "Wait For Selector", "type": "string", "description": "Optional CSS selector to wait for before auditing. Useful for SPAs that load content dynamically." }, "timeout": { "title": "Page Load Timeout (ms)", "minimum": 5000, "maximum": 60000, "type": "integer", "description": "Maximum time to wait for page load in milliseconds.", "default": 30000 }, "dryRun": { "title": "Dry Run", "type": "boolean", "description": "If true, runs without saving results or sending webhooks. Useful for testing.", "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 } } } } } } } } } } ```