{ "openapi": "3.0.1", "info": { "title": "Website Accessibility Checker: WCAG 2.2 & EAA Audit (axe-core)", "description": "Audit web pages or whole sites for WCAG 2.0, 2.1 and 2.2 accessibility issues with axe-core in a real browser: each violation with severity, WCAG criterion, offending element and how to fix it, plus a score and site summary. Useful for the European Accessibility Act.", "version": "0.1", "x-build-id": "PcVM3wqbmGrGECiIp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/latamdatatools~accessibility-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-latamdatatools-accessibility-audit", "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/latamdatatools~accessibility-audit/runs": { "post": { "operationId": "runs-sync-latamdatatools-accessibility-audit", "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/latamdatatools~accessibility-audit/run-sync": { "post": { "operationId": "run-sync-latamdatatools-accessibility-audit", "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", "properties": { "urls": { "title": "Page URLs", "type": "array", "description": "One URL (or domain = its home page) per line.", "items": { "type": "string" } }, "wcagLevel": { "title": "WCAG conformance level", "enum": [ "wcag2a", "wcag2aa", "wcag21a", "wcag21aa", "wcag22aa", "wcag22aaa" ], "type": "string", "description": "Which axe-core rule set to run. WCAG 2.1 AA is the level referenced by the European Accessibility Act (EN 301 549) and most laws.", "default": "wcag21aa" }, "includeBestPractices": { "title": "Also run best-practice rules", "type": "boolean", "description": "axe-core best practices that are not WCAG requirements (landmarks, heading order, region...).", "default": false }, "includeNeedsReview": { "title": "Include \"needs review\" items", "type": "boolean", "description": "Checks axe-core could not decide automatically (e.g. text over background images). Listed in \"needsReview\" for a human to check.", "default": true }, "viewport": { "title": "Viewport", "enum": [ "desktop", "mobile" ], "type": "string", "description": "Desktop (1366 px) or mobile (390 px, touch).", "default": "desktop" }, "maxElementsPerRule": { "title": "Elements listed per failed rule", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many offending elements (selector, HTML and how to fix) to list for each failed rule. The total count is always given.", "default": 10 }, "crawlSameSite": { "title": "Crawl the site", "type": "boolean", "description": "Also audit pages linked from each start URL on the same host (no login, cart or account pages), up to \"Max pages per site\".", "default": false }, "maxPagesPerSite": { "title": "Max pages per site", "minimum": 1, "maximum": 200, "type": "integer", "description": "Including the start URL(s) of that site.", "default": 10 }, "maxPages": { "title": "Max pages in total", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap for the run (up to 2,000). Your max charge per run is respected too.", "default": 100 }, "datasetId": { "title": "Dataset (from another Actor run)", "type": "string", "description": "Optional: audit the URLs stored in an Apify dataset. Use \"URL field\" to say which field holds the URL." }, "csvUrl": { "title": "CSV file URL", "type": "string", "description": "Optional: a public CSV file with a header row (Google Sheets links work if shared as \"Anyone with the link\")." }, "urlField": { "title": "URL field", "type": "string", "description": "Field / CSV column that holds the URL, e.g. url, website.", "default": "url" }, "keepFields": { "title": "Fields to keep from the source", "type": "array", "description": "Optional: copy these fields of each dataset record / CSV row into the output (under \"source\").", "items": { "type": "string" } }, "maxConcurrency": { "title": "Pages in parallel", "minimum": 1, "maximum": 4, "type": "integer", "description": "Browser tabs at the same time. 2 fits in 1 GB of memory; use 3-4 with 2 GB or more.", "default": 2 }, "pageTimeoutSecs": { "title": "Page load timeout (seconds)", "minimum": 10, "maximum": 90, "type": "integer", "description": "If the page is still loading after this time, the audit runs on what has loaded.", "default": 45 }, "waitAfterLoadSecs": { "title": "Wait after load (seconds)", "minimum": 0, "maximum": 10, "type": "integer", "description": "Extra time for JavaScript to render the page before the audit.", "default": 1 } } }, "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 } } } } } } } } } }