{ "openapi": "3.0.1", "info": { "title": "EU Accessibility Scanner (WCAG 2.1 AA / EAA)", "description": "Bulk WCAG 2.1 AA checker for the European Accessibility Act. Not an overlay: scans your pages in a real browser and reports each issue in your actual code, mapped to WCAG and EN 301 549, with fix guidance (EN/NL) and an HTML + PDF audit report. No subscription: pay per page.", "version": "0.1", "x-build-id": "iAOd57GlyjRHlCc2G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mrdexter4~eu-accessibility-scanner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mrdexter4-eu-accessibility-scanner", "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/mrdexter4~eu-accessibility-scanner/runs": { "post": { "operationId": "runs-sync-mrdexter4-eu-accessibility-scanner", "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/mrdexter4~eu-accessibility-scanner/run-sync": { "post": { "operationId": "run-sync-mrdexter4-eu-accessibility-scanner", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Websites to scan", "type": "array", "description": "Homepage (or any page) of each website to scan. Each distinct domain is treated as a separate site with its own summary and report. Several URLs on the same domain are all included in that site's scan.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxPages": { "title": "Max pages per site", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper limit of pages scanned (and charged) per website.", "default": 50 }, "language": { "title": "Report language", "enum": [ "en", "nl" ], "type": "string", "description": "Language of the HTML/PDF report and the fix guidance in the dataset.", "default": "en" }, "monitorMode": { "title": "Monitor mode (only new & fixed issues)", "type": "boolean", "description": "Compare with the previous run for the same site (stored in a named key-value store) and output only issues that are new or were fixed. Ideal for weekly/monthly schedules. The first run outputs all issues as \"new\".", "default": false }, "monitorStoreName": { "title": "Monitor history store name", "type": "string", "description": "Named key-value store used to keep scan history between runs. Use different names to keep separate baselines (e.g. per client).", "default": "eaa-scanner-monitor" }, "useSitemap": { "title": "Discover pages from sitemap.xml", "type": "boolean", "description": "Read robots.txt / sitemap.xml (including sitemap indexes and .gz) to find pages. If the sitemap is missing or tiny, the scanner falls back to following links from the start URL.", "default": true }, "crawlScope": { "title": "Crawl scope", "enum": [ "site", "path" ], "type": "string", "description": "\"Whole site\" scans any page on the same domain. \"Start URL folder only\" stays within the folder of the start URL (e.g. /shop/).", "default": "site" }, "dedupeTemplates": { "title": "Skip pages that share a template", "type": "boolean", "description": "Group URLs by pattern (e.g. /product/* or /blog/2024/*) and scan only a few per group. Saves cost on large shops where 1,000 product pages share one template. Disable to scan every URL up to the page limit.", "default": true }, "maxPagesPerTemplate": { "title": "Pages per template group", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many pages to scan per URL pattern group when template dedupe is on.", "default": 2 }, "includeBestPractices": { "title": "Include best-practice rules", "type": "boolean", "description": "Also report axe-core best-practice rules (landmarks, heading order, …). These are not WCAG requirements and are clearly labelled as such.", "default": false }, "viewport": { "title": "Viewport", "enum": [ "desktop", "mobile" ], "type": "string", "description": "Screen size used to render pages.", "default": "desktop" }, "maxIssuesPerRulePerPage": { "title": "Max issue rows per rule per page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Caps dataset rows when one rule fails on hundreds of elements of the same page (e.g. contrast on every product tile).", "default": 25 }, "generateReport": { "title": "Generate HTML report", "type": "boolean", "description": "Save a client-ready HTML report to the key-value store (report.html, plus report-.html per site when scanning several sites).", "default": true }, "generatePdf": { "title": "Also generate PDF", "type": "boolean", "description": "Render the report to PDF (report.pdf).", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Pages scanned in parallel. Higher is faster but needs more memory (≈ 1 GB per 2 pages).", "default": 4 }, "pageTimeoutSecs": { "title": "Page load timeout (seconds)", "minimum": 10, "maximum": 300, "type": "integer", "description": "Navigation timeout per page.", "default": 60 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Use Apify Proxy (residential) for sites behind aggressive bot protection.", "default": { "useApifyProxy": 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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }