About this endpoint
What it does
Runs a WCAG 2.1 AA accessibility audit of a page in a real browser. Returns an accessibility score, every violation with the affected elements and a plain-English fix, items that need a human check, and a prioritized fix list.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The URL to audit for ADA/WCAG compliance |
| include | String | No | trackers adds the tracker and pixel inventory to the report |
Response
A JSON object; nested fields are written parent.child, and [] marks an array of objects.
| Field | Type | Description |
|---|---|---|
url | string | The URL that was checked, as you sent it. |
grade | string | Letter grade from A+ to F. |
score | number | Score, 0–100. |
summary | object | Rule counts for the page. |
summary.passes | integer | WCAG rules passed. |
summary.incomplete | integer | Rules automated testing could not decide; listed in needs_review. |
summary.violations | integer | WCAG rules failed. |
summary.total_rules_checked | integer | WCAG rules evaluated. |
summary.best_practice_issues | integer | Best-practice (non-WCAG) rules failed; listed in best_practices. |
standard | string | Standard checked against — WCAG 2.1 AA. |
categories | object | Score per category; each has its checks. |
categories.aria | object | ARIA attributes and roles. |
categories.aria.label | string | Category name for display. |
categories.aria.score | number | Category score, 0–100. |
categories.aria.issues | array | Failed rules in this category. |
categories.aria.passes | integer | Rules passed in this category. |
categories.aria.violations | integer | Rules failed in this category. |
categories.forms | object | Form labels and inputs. |
categories.forms.label | string | Category name for display. |
categories.forms.score | number | Category score, 0–100. |
categories.forms.issues | array | Failed rules in this category. |
categories.forms.passes | integer | Rules passed in this category. |
categories.forms.violations | integer | Rules failed in this category. |
categories.other | object | Rules not in another category. |
categories.other.label | string | Category name for display. |
categories.other.score | number | Category score, 0–100. |
categories.other.issues | array | Failed rules in this category. |
categories.other.passes | integer | Rules passed in this category. |
categories.other.violations | integer | Rules failed in this category. |
categories.images | object | Image alternative text. |
categories.images.label | string | Category name for display. |
categories.images.score | number | Category score, 0–100. |
categories.images.issues | array | Failed rules in this category. |
categories.images.passes | integer | Rules passed in this category. |
categories.images.violations | integer | Rules failed in this category. |
categories.tables | object | |
categories.tables.label | string | |
categories.tables.score | number | |
categories.tables.issues | array | |
categories.tables.passes | integer | |
categories.tables.violations | integer | |
categories.keyboard | object | Keyboard access and focus. |
categories.keyboard.label | string | Category name for display. |
categories.keyboard.score | number | Category score, 0–100. |
categories.keyboard.issues | array | Failed rules in this category. |
categories.keyboard.passes | integer | Rules passed in this category. |
categories.keyboard.violations | integer | Rules failed in this category. |
categories.viewport | object | Zoom and viewport settings. |
categories.viewport.label | string | Category name for display. |
categories.viewport.score | number | Category score, 0–100. |
categories.viewport.issues | array | Failed rules in this category. |
categories.viewport.passes | integer | Rules passed in this category. |
categories.viewport.violations | integer | Rules failed in this category. |
categories.structure | object | Landmarks, headings, page language and title. |
categories.structure.label | string | Category name for display. |
categories.structure.score | number | Category score, 0–100. |
categories.structure.issues | array | Failed rules in this category. |
categories.structure.passes | integer | Rules passed in this category. |
categories.structure.violations | integer | Rules failed in this category. |
categories.links_buttons | object | Link and button names. |
categories.links_buttons.label | string | Category name for display. |
categories.links_buttons.score | number | Category score, 0–100. |
categories.links_buttons.issues | array | Failed rules in this category. |
categories.links_buttons.passes | integer | Rules passed in this category. |
categories.links_buttons.violations | integer | Rules failed in this category. |
categories.color_contrast | object | Text colour contrast. |
categories.color_contrast.label | string | Category name for display. |
categories.color_contrast.score | number | Category score, 0–100. |
categories.color_contrast.issues | array | Failed rules in this category. |
categories.color_contrast.passes | integer | Rules passed in this category. |
categories.color_contrast.violations | integer | Rules failed in this category. |
priorities | array of object | Fix list, most important first. |
priorities[].fix | string | The change to make. |
priorities[].type | string | wcag (a WCAG 2.1 A/AA requirement) or best_practice (recommended, not required). |
priorities[].issue | string | The problem found, in a short phrase. |
priorities[].impact | string | Severity for users of assistive technology — critical, serious, moderate or minor. |
priorities[].rule_id | string | axe-core rule ID (e.g. bypass, color-contrast); help_url explains it. |
priorities[].help_url | string | Deque University page explaining the rule and how to fix it. |
priorities[].severity | string | How much fixing it matters — high, medium or low. |
priorities[].affected_elements | integer | Number of elements on the page that triggered the rule. |
violations | array of object | WCAG rules the page fails, worst first. |
violations[].fix | string | |
violations[].help | string | |
violations[].type | string | |
violations[].impact | string | |
violations[].rule_id | string | |
violations[].category | string | |
violations[].help_url | string | |
violations[].wcag_tags | array | |
violations[].description | string | |
violations[].element_samples | array | |
violations[].affected_elements | integer | |
lawsuit_risk | object | Provider's rough estimate of ADA-claim exposure from automated findings. Not legal advice. |
lawsuit_risk.level | string | Risk level, e.g. minimal. |
lawsuit_risk.summary | string | One-line verdict for this sub-score. |
lawsuit_risk.high_risk_violations | array of object | Rule IDs of violations most often cited in ADA claims. |
needs_review | array of object | Rules automated testing could not decide; check these by hand. |
needs_review[].help | string | The rule in one line. |
needs_review[].type | string | wcag (a WCAG 2.1 A/AA requirement) or best_practice (recommended, not required). |
needs_review[].impact | string | Severity for users of assistive technology — critical, serious, moderate or minor. |
needs_review[].rule_id | string | axe-core rule ID (e.g. bypass, color-contrast); help_url explains it. |
needs_review[].help_url | string | Deque University page explaining the rule and how to fix it. |
needs_review[].wcag_tags | array of string | WCAG success criteria and level the rule maps to (e.g. wcag2aa, wcag143). |
needs_review[].description | string | What the rule checks. |
needs_review[].what_to_check | string | What a person should verify by hand. |
needs_review[].element_samples | array of object | Up to a few example elements that triggered the rule. |
needs_review[].element_samples[].html | string | The element's HTML. |
needs_review[].element_samples[].target | array of string | CSS selector that locates the element. |
needs_review[].element_samples[].reason | string | Why it needs a human check. |
needs_review[].affected_elements | integer | Number of elements on the page that triggered the rule. |
response_code | integer | HTTP status the page returned. |
best_practices | array of object | Recommended (non-WCAG) rules the page fails; they do not affect the score. |
best_practices[].fix | string | How to fix it. |
best_practices[].help | string | The rule in one line. |
best_practices[].type | string | wcag (a WCAG 2.1 A/AA requirement) or best_practice (recommended, not required). |
best_practices[].impact | string | Severity for users of assistive technology — critical, serious, moderate or minor. |
best_practices[].rule_id | string | axe-core rule ID (e.g. bypass, color-contrast); help_url explains it. |
best_practices[].category | string | Category the rule belongs to (e.g. aria, structure, color_contrast). |
best_practices[].help_url | string | Deque University page explaining the rule and how to fix it. |
best_practices[].wcag_tags | array | WCAG success criteria and level the rule maps to (e.g. wcag2aa, wcag143). |
best_practices[].description | string | What the rule checks. |
best_practices[].element_samples | array of object | Up to a few example elements that triggered the rule. |
best_practices[].element_samples[].html | string | The element's HTML. |
best_practices[].element_samples[].target | array of string | CSS selector that locates the element. |
best_practices[].element_samples[].fix_suggestion | string | How to fix this element. |
best_practices[].element_samples[].failure_summary | string | Why the element fails the rule. |
best_practices[].affected_elements | integer | Number of elements on the page that triggered the rule. |