{ "openapi": "3.0.1", "info": { "title": "WCAG 2.2 & EAA Accessibility Checker ยท SiteVerdict", "description": "Audit websites for WCAG 2.2 AA and European Accessibility Act (EN 301 549) issues on desktop and mobile. axe-core plus keyboard focus, focus traps, target size, 320px reflow and reduced-motion checks. Scores, top 10 fixes and a shareable HTML report.", "version": "1.0", "x-build-id": "Htb5p0nVX5LFxymu0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/siteverdict~siteverdict-accessibility-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-accessibility-auditor", "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/siteverdict~siteverdict-accessibility-auditor/runs": { "post": { "operationId": "runs-sync-siteverdict-siteverdict-accessibility-auditor", "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/siteverdict~siteverdict-accessibility-auditor/run-sync": { "post": { "operationId": "run-sync-siteverdict-siteverdict-accessibility-auditor", "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": "Website URLs to audit", "type": "array", "description": "Pages to audit (e.g. your home page, a product page, checkout entry, contact form). Each URL is audited once per selected device. With crawling on, these are also the starting points for discovering internal pages.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "crawl": { "title": "Crawl internal pages", "type": "boolean", "description": "Follow links on the start page(s) to audit more pages of the same website (same hostname; www. ignored). Respects robots.txt. Login, cart, checkout and admin URLs are skipped.", "default": false }, "maxPagesPerSite": { "title": "Max pages per website", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of pages audited per website, including the start URL(s). Only used when crawling is on.", "default": 10 }, "maxCrawlDepth": { "title": "Max crawl depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many clicks away from the start URL to follow links (1 = only pages linked from the start page).", "default": 2 }, "maxPagesTotal": { "title": "Max pages in total", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on pages audited in this run across all websites (each audited page is one billable event). The run also never exceeds your 'Max total charge' budget.", "default": 100 }, "includeUrlPatterns": { "title": "Only crawl URLs matching (regex)", "type": "array", "description": "Optional. Only crawl discovered URLs matching at least one of these regular expressions, e.g. /products/ or /en-gb/.", "items": { "type": "string" } }, "excludeUrlPatterns": { "title": "Never crawl URLs matching (regex)", "type": "array", "description": "Optional. Skip discovered URLs matching any of these regular expressions, e.g. /blog/page/ or \\?sort=.", "items": { "type": "string" } }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Do not crawl discovered links disallowed by robots.txt. Start URLs you enter are always audited.", "default": true }, "devices": { "title": "Devices", "type": "array", "description": "Desktop = 1366x900 viewport. Mobile = 390x844 touch viewport with a mobile user agent (page is reloaded). Both are included in the per-page price.", "items": { "type": "string", "enum": [ "desktop", "mobile" ], "enumTitles": [ "Desktop (1366 px)", "Mobile (390 px)" ] }, "default": [ "desktop", "mobile" ] }, "wcagLevel": { "title": "WCAG conformance level", "enum": [ "A", "AA", "AAA" ], "type": "string", "description": "AA is what the European Accessibility Act (via EN 301 549), the UK public sector regulations and most laws reference. AAA adds enhanced contrast and other optional rules.", "default": "AA" }, "includeBestPractices": { "title": "Include best-practice rules", "type": "boolean", "description": "Also report issues that are not strict WCAG failures but hurt real users (landmarks, heading order, one h1...). Marked as 'Best practice'.", "default": true }, "includeNeedsReview": { "title": "Include 'needs review' items", "type": "boolean", "description": "Report items that automated tools cannot decide (e.g. contrast over images, vague link text). They never lower the score.", "default": true }, "keyboardTabStops": { "title": "Keyboard test: Tab presses", "minimum": 0, "maximum": 100, "type": "integer", "description": "How many Tab key presses to simulate to check visible focus, focus hidden behind sticky content, focus traps and skip links. 0 disables the keyboard test.", "default": 25 }, "checkReflow": { "title": "Check reflow at 320 px (400% zoom)", "type": "boolean", "description": "Detect horizontal scrolling and cut-off content at 320 CSS px width (WCAG 1.4.10).", "default": true }, "checkMotion": { "title": "Check animations and reduced motion", "type": "boolean", "description": "Detect long or infinite animations and whether they stop when the user enables 'reduce motion' (WCAG 2.2.2 / 2.3.3).", "default": true }, "maxNodesPerRule": { "title": "Max example elements per issue", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many affected elements (selector + HTML snippet) to store per issue per page. The total count is always reported.", "default": 20 }, "generateHtmlReport": { "title": "Generate HTML report", "type": "boolean", "description": "Save a shareable, printable HTML report (key-value store record REPORT) plus a JSON site summary (record SUMMARY).", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Usually not needed for accessibility audits. Use Apify Proxy if a site blocks data-centre traffic. The Actor never tries to bypass CAPTCHAs or bot protection; blocked pages are reported and not charged.", "default": { "useApifyProxy": false } }, "maxConcurrency": { "title": "Max concurrent pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Upper limit of pages audited in parallel. Actual concurrency also scales with the memory you give the run (about 1 GB per parallel page).", "default": 4 }, "navigationTimeoutSecs": { "title": "Page load timeout (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "Maximum time to wait for a page to load.", "default": 30 }, "pageTimeoutSecs": { "title": "Per-page audit timeout (seconds)", "minimum": 30, "maximum": 600, "type": "integer", "description": "Maximum time for the full audit of one URL (all devices). Pages that time out are retried once, then reported as failed and not charged.", "default": 100 }, "waitAfterLoadMs": { "title": "Extra wait after load (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Additional settle time after the page load event (for slow client-side rendering).", "default": 1000 } } }, "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 } } } } } } } } } }