apyhub
Back
▣ SAFETY KIT · MEDIA KIT

Audit Webpage Accessibility API

What it does

Accessibility Audit checks a page URL for ADA and WCAG 2.1 AA accessibility issues. Send a url, and you get back the audit result for that page. If you include trackers, the report also adds tracker and pixel inventory details.

Use Accessibility Audit when you need a fast pre-check before publishing a landing page, product page, or marketing site. It helps you spot accessibility gaps early in your build or QA flow, before they become release blockers or compliance issues.

It has one endpoint, ADA / WCAG 2.1 AA accessibility audit.

The JSON response lists every WCAG violation with affected elements and a fix, items that need a human check, and a prioritized fix list.

GET
ADA / WCAG 2.1 AA accessibility audit
https://api.eu.apyhub.com/seoscoreapi/audit-webpage-accessibility

QUICKSTART

GUIDE

Quickstart

Audit a webpage for ADA/WCAG compliance by passing the target URL as a query parameter.

curl -X GET "https://api.eu.apyhub.com/seoscoreapi/audit-webpage-accessibility?url=https%3A%2F%2Fwww.wikipedia.org" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

A real response to the request above, with every array cut to its first 2 items:

{
  "url": "https://www.wikipedia.org/",
  "score": 100,
  "grade": "A+",
  "standard": "WCAG 2.1 AA",
  "response_code": 200,
  "summary": {
    "total_rules_checked": 51,
    "violations": 0,
    "passes": 32,
    "incomplete": 2,
    "best_practice_issues": 1
  },
  "lawsuit_risk": {
    "level": "minimal",
    "summary": "No automated WCAG 2.1 AA violations detected. 1 best-practice suggestion(s) are listed under best_practices; they are not WCAG requirements and don't affect the score or risk level. 2 check(s) need manual review (see needs_review).",
    "high_risk_violations": []
  },
  "categories": {
    "aria": {
      "label": "ARIA Attributes",
      "score": 100.0,
      "violations": 0,
      "passes": 7,
      "issues": []
    },
    "color_contrast": {
      "label": "Color Contrast",
      "score": 100.0,
      "violations": 0,
      "passes": 2,
      "issues": []
    },
    "forms": {
      "label": "Forms & Labels",
      "score": 100.0,
      "violations": 0,
      "passes": 3,
      "issues": []
    },
    "images": {
      "label": "Images & Alt Text",
      "score": 100.0,
      "violations": 0,
      "passes": 2,
      "issues": []
    },
    "keyboard": {
      "label": "Keyboard & Navigation",
      "score": 100.0,
      "violations": 0,
      "passes": 2,
      "issues": []
    },
    "links_buttons": {
      "label": "Links & Buttons",
      "score": 100.0,
      "violations": 0,
      "passes": 3,
      "issues": []
    },
    "other": {
      "label": "Other",
      "score": 100.0,
      "violations": 0,
      "passes": 9,
      "issues": []
    },
    "structure": {
      "label": "Document Structure",
      "score": 100.0,
      "violations": 0,
      "passes": 3,
      "issues": []
    },
    "viewport": {
      "label": "Viewport & Zoom",
      "score": 100.0,
      "violations": 0,
      "passes": 1,
      "issues": []
    }
  },
  "violations": [],
  "best_practices": [
    {
      "rule_id": "heading-order",
      "impact": "moderate",
      "type": "best_practice",
      "description": "Ensure the order of headings is semantically correct",
      "help": "Heading levels should only increase by one",
      "help_url": "https://dequeuniversity.com/rules/axe/4.10/heading-order?application=axeAPI",
      "wcag_tags": [],
      "category": "structure",
      "fix": "Don't skip heading levels: an <h2> should follow an <h1>, an <h3> an <h2>. Change the tag, not just the font size.",
      "affected_elements": 1,
      "element_samples": [
        {
          "html": "<h3>",
          "target": [
            ".overlay-banner-mini-message-text.overlay-banner-control > h3"
          ],
          "fix_suggestion": "Don't skip heading levels: an <h2> should follow an <h1>, an <h3> an <h2>. Change the tag, not just the font size.",
          "failure_summary": "Fix any of the following:\n  Heading order invalid"
        }
      ]
    }
  ],
  "needs_review": [
    {
      "rule_id": "color-contrast",
      "type": "wcag",
      "impact": "serious",
      "description": "Ensure the contrast between foreground and background colors meets WCAG 2 AA minimum contrast ratio thresholds",
      "help": "Elements must meet minimum color contrast ratio thresholds",
      "help_url": "https://dequeuniversity.com/rules/axe/4.10/color-contrast?application=axeAPI",
      "wcag_tags": [
        "wcag2aa",
        "wcag143"
      ],
      "what_to_check": "Contrast couldn't be measured automatically, usually because the text sits on a background image, gradient, or an overlapping element. Check it with a contrast checker: 4.5:1 for normal text, 3:1 for large text.",
      "affected_elements": 10,
      "element_samples": [
        {
          "html": "<a href=\"https://donate.wikimedia.org/?wmf_medium=portal&amp;wmf_campaign=portalBanner&amp;wmf_source=portalBanner_en6C_2627_1102_YoYTestCBCopy&amp;uselang=en&amp;appeal=SupportingWikipedia\" id=\"frb-d",
          "target": [
            "#frb-donate"
          ],
          "reason": "Element's background color could not be determined because it's partially obscured by another element"
        },
        {
          "html": "<p>Proud host of Wikipedia and other free knowledge projects</p>",
          "target": [
            ".overlay-banner-main-footer-identity > p"
          ],
          "reason": "Element's background color could not be determined because it's partially obscured by another element"
        }
      ]
    },
    {
      "rule_id": "link-in-text-block",
      "type": "wcag",
      "impact": "serious",
      "description": "Ensure links are distinguished from surrounding text in a way that does not rely on color",
      "help": "Links must be distinguishable without relying on color",
      "help_url": "https://dequeuniversity.com/rules/axe/4.10/link-in-text-block?application=axeAPI",
      "wcag_tags": [
        "wcag2a",
        "wcag141"
      ],
      "what_to_check": "Check that links in body text can be told apart from the text around them without relying on color.",
      "affected_elements": 2,
      "element_samples": [
        {
          "html": "<a class=\"frb-link-privacy\" href=\"https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Donor_privacy_policy?uselang=en\" target=\"_blank\">donor privacy policy</a>",
          "target": [
            ".frb-link-privacy"
          ],
          "reason": "Element's foreground contrast ratio could not be determined"
        },
        {
          "html": "<a class=\"frb-link-tax\" href=\"https://wikimediafoundation.org/give/donor-frequently-asked-questions/#tax-deductibility\" target=\"_blank\">Wikimedia Foundation</a>",
          "target": [
            ".frb-link-tax"
          ],
          "reason": "Element's foreground contrast ratio could not be determined"
        }
      ]
    }
  ],
  "priorities": [
    {
      "severity": "low",
      "impact": "moderate",
      "type": "best_practice",
      "rule_id": "heading-order",
      "issue": "Heading levels should only increase by one",
      "fix": "Don't skip heading levels: an <h2> should follow an <h1>, an <h3> an <h2>. Change the tag, not just the font size.",
      "help_url": "https://dequeuniversity.com/rules/axe/4.10/heading-order?application=axeAPI",
      "affected_elements": 1
    }
  ]
}
TRY ITLIVE · 1000 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
The page to audit for ADA / WCAG 2.1 AA accessibility, as a full URL including `https://`.
`trackers` adds the tracker and pixel inventory to the report

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)

AttributeTypeMandatoryDescription
urlStringYesThe URL to audit for ADA/WCAG compliance
includeStringNotrackers 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.

FieldTypeDescription
urlstringThe URL that was checked, as you sent it.
gradestringLetter grade from A+ to F.
scorenumberScore, 0–100.
summaryobjectRule counts for the page.
summary.passesintegerWCAG rules passed.
summary.incompleteintegerRules automated testing could not decide; listed in needs_review.
summary.violationsintegerWCAG rules failed.
summary.total_rules_checkedintegerWCAG rules evaluated.
summary.best_practice_issuesintegerBest-practice (non-WCAG) rules failed; listed in best_practices.
standardstringStandard checked against — WCAG 2.1 AA.
categoriesobjectScore per category; each has its checks.
categories.ariaobjectARIA attributes and roles.
categories.aria.labelstringCategory name for display.
categories.aria.scorenumberCategory score, 0–100.
categories.aria.issuesarrayFailed rules in this category.
categories.aria.passesintegerRules passed in this category.
categories.aria.violationsintegerRules failed in this category.
categories.formsobjectForm labels and inputs.
categories.forms.labelstringCategory name for display.
categories.forms.scorenumberCategory score, 0–100.
categories.forms.issuesarrayFailed rules in this category.
categories.forms.passesintegerRules passed in this category.
categories.forms.violationsintegerRules failed in this category.
categories.otherobjectRules not in another category.
categories.other.labelstringCategory name for display.
categories.other.scorenumberCategory score, 0–100.
categories.other.issuesarrayFailed rules in this category.
categories.other.passesintegerRules passed in this category.
categories.other.violationsintegerRules failed in this category.
categories.imagesobjectImage alternative text.
categories.images.labelstringCategory name for display.
categories.images.scorenumberCategory score, 0–100.
categories.images.issuesarrayFailed rules in this category.
categories.images.passesintegerRules passed in this category.
categories.images.violationsintegerRules failed in this category.
categories.tablesobject
categories.tables.labelstring
categories.tables.scorenumber
categories.tables.issuesarray
categories.tables.passesinteger
categories.tables.violationsinteger
categories.keyboardobjectKeyboard access and focus.
categories.keyboard.labelstringCategory name for display.
categories.keyboard.scorenumberCategory score, 0–100.
categories.keyboard.issuesarrayFailed rules in this category.
categories.keyboard.passesintegerRules passed in this category.
categories.keyboard.violationsintegerRules failed in this category.
categories.viewportobjectZoom and viewport settings.
categories.viewport.labelstringCategory name for display.
categories.viewport.scorenumberCategory score, 0–100.
categories.viewport.issuesarrayFailed rules in this category.
categories.viewport.passesintegerRules passed in this category.
categories.viewport.violationsintegerRules failed in this category.
categories.structureobjectLandmarks, headings, page language and title.
categories.structure.labelstringCategory name for display.
categories.structure.scorenumberCategory score, 0–100.
categories.structure.issuesarrayFailed rules in this category.
categories.structure.passesintegerRules passed in this category.
categories.structure.violationsintegerRules failed in this category.
categories.links_buttonsobjectLink and button names.
categories.links_buttons.labelstringCategory name for display.
categories.links_buttons.scorenumberCategory score, 0–100.
categories.links_buttons.issuesarrayFailed rules in this category.
categories.links_buttons.passesintegerRules passed in this category.
categories.links_buttons.violationsintegerRules failed in this category.
categories.color_contrastobjectText colour contrast.
categories.color_contrast.labelstringCategory name for display.
categories.color_contrast.scorenumberCategory score, 0–100.
categories.color_contrast.issuesarrayFailed rules in this category.
categories.color_contrast.passesintegerRules passed in this category.
categories.color_contrast.violationsintegerRules failed in this category.
prioritiesarray of objectFix list, most important first.
priorities[].fixstringThe change to make.
priorities[].typestringwcag (a WCAG 2.1 A/AA requirement) or best_practice (recommended, not required).
priorities[].issuestringThe problem found, in a short phrase.
priorities[].impactstringSeverity for users of assistive technology — critical, serious, moderate or minor.
priorities[].rule_idstringaxe-core rule ID (e.g. bypass, color-contrast); help_url explains it.
priorities[].help_urlstringDeque University page explaining the rule and how to fix it.
priorities[].severitystringHow much fixing it matters — high, medium or low.
priorities[].affected_elementsintegerNumber of elements on the page that triggered the rule.
violationsarray of objectWCAG rules the page fails, worst first.
violations[].fixstring
violations[].helpstring
violations[].typestring
violations[].impactstring
violations[].rule_idstring
violations[].categorystring
violations[].help_urlstring
violations[].wcag_tagsarray
violations[].descriptionstring
violations[].element_samplesarray
violations[].affected_elementsinteger
lawsuit_riskobjectProvider's rough estimate of ADA-claim exposure from automated findings. Not legal advice.
lawsuit_risk.levelstringRisk level, e.g. minimal.
lawsuit_risk.summarystringOne-line verdict for this sub-score.
lawsuit_risk.high_risk_violationsarray of objectRule IDs of violations most often cited in ADA claims.
needs_reviewarray of objectRules automated testing could not decide; check these by hand.
needs_review[].helpstringThe rule in one line.
needs_review[].typestringwcag (a WCAG 2.1 A/AA requirement) or best_practice (recommended, not required).
needs_review[].impactstringSeverity for users of assistive technology — critical, serious, moderate or minor.
needs_review[].rule_idstringaxe-core rule ID (e.g. bypass, color-contrast); help_url explains it.
needs_review[].help_urlstringDeque University page explaining the rule and how to fix it.
needs_review[].wcag_tagsarray of stringWCAG success criteria and level the rule maps to (e.g. wcag2aa, wcag143).
needs_review[].descriptionstringWhat the rule checks.
needs_review[].what_to_checkstringWhat a person should verify by hand.
needs_review[].element_samplesarray of objectUp to a few example elements that triggered the rule.
needs_review[].element_samples[].htmlstringThe element's HTML.
needs_review[].element_samples[].targetarray of stringCSS selector that locates the element.
needs_review[].element_samples[].reasonstringWhy it needs a human check.
needs_review[].affected_elementsintegerNumber of elements on the page that triggered the rule.
response_codeintegerHTTP status the page returned.
best_practicesarray of objectRecommended (non-WCAG) rules the page fails; they do not affect the score.
best_practices[].fixstringHow to fix it.
best_practices[].helpstringThe rule in one line.
best_practices[].typestringwcag (a WCAG 2.1 A/AA requirement) or best_practice (recommended, not required).
best_practices[].impactstringSeverity for users of assistive technology — critical, serious, moderate or minor.
best_practices[].rule_idstringaxe-core rule ID (e.g. bypass, color-contrast); help_url explains it.
best_practices[].categorystringCategory the rule belongs to (e.g. aria, structure, color_contrast).
best_practices[].help_urlstringDeque University page explaining the rule and how to fix it.
best_practices[].wcag_tagsarrayWCAG success criteria and level the rule maps to (e.g. wcag2aa, wcag143).
best_practices[].descriptionstringWhat the rule checks.
best_practices[].element_samplesarray of objectUp to a few example elements that triggered the rule.
best_practices[].element_samples[].htmlstringThe element's HTML.
best_practices[].element_samples[].targetarray of stringCSS selector that locates the element.
best_practices[].element_samples[].fix_suggestionstringHow to fix this element.
best_practices[].element_samples[].failure_summarystringWhy the element fails the rule.
best_practices[].affected_elementsintegerNumber of elements on the page that triggered the rule.
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.