# HTML Accessibility Essentials Auditor (`quanmatrix/html-accessibility-essentials-auditor`) Actor

Audit essential server-rendered HTML accessibility signals including language, headings, image alternatives, form labels, landmarks and document metadata.

- **URL**: https://apify.com/quanmatrix/html-accessibility-essentials-auditor.md
- **Developed by:** [Rafael Barreto Haddad](https://apify.com/quanmatrix) (community)
- **Categories:** Developer tools, SEO tools, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.01 / 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.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

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

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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

## HTML Accessibility Essentials Auditor

Lightweight accessibility hygiene checks for public web pages, designed for release QA, agency audits, and recurring monitoring.

### Key features

- Checks document language and page title.
- Counts H1 elements and flags pages without a primary heading.
- Counts images and images missing meaningful `alt` attributes.
- Checks common form controls for associated labels or accessible names.
- Detects common semantic landmarks such as `main`, `nav`, and `header`.
- Reports viewport metadata and one structured score per URL.

### Input

```json
{"urls":["https://www.python.org/","https://example.com/"]}
```

### Output

Each dataset item contains the requested and final URL, HTTP status, score, issues, heading counts, image accessibility counts, form-label counts, and landmark signals.

### Example

A page with 20 images and 2 missing `alt` attributes returns `images: 20`, `imagesMissingAlt: 2`, an issue explaining the ratio, plus the other document-level checks in the same record.

### Why use this Actor

1. **Concrete counts** reveal what needs fixing instead of hiding everything behind one score.
2. **Fast HTTP-only checks** are suitable for recurring release gates and portfolio monitoring.
3. **Accessible-name checks** cover labels, `aria-label`, and `aria-labelledby` for common form controls.
4. **No paid accessibility API or AI dependency**, keeping recurring costs predictable.

### Pricing

Pay per dataset result. One URL audit produces one primary chargeable result. Pricing is optimized for repeated QA rather than a large one-off audit fee.

### Good use cases

- Pre-release accessibility hygiene
- Agency website inventories
- CI regression checks
- Prioritizing pages for deeper manual or browser-based accessibility testing

### Limitations

- This is not a WCAG certification or legal compliance determination.
- JavaScript-only DOM changes are outside an HTTP-only run.
- Manual keyboard, screen-reader, color contrast, focus, and usability testing remain necessary.

### Privacy and safety

Only public HTTP(S) targets are accepted. Private and unsafe redirect destinations are rejected. No credentials or external AI service are required.

# Actor input Schema

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

Public HTTP(S) URLs to inspect

## Actor input object example

```json
{
  "urls": [
    "https://example.com/"
  ]
}
```

# Actor output Schema

## `results` (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 = {};

// Run the Actor and wait for it to finish
const run = await client.actor("quanmatrix/html-accessibility-essentials-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 = {}

# Run the Actor and wait for it to finish
run = client.actor("quanmatrix/html-accessibility-essentials-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 '{}' |
apify call quanmatrix/html-accessibility-essentials-auditor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,quanmatrix/html-accessibility-essentials-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/eEaAndC7gXx9QuDfH/builds/mXwU84ffRUsbh6kDP/openapi.json
