ScoutAPI in development · launch 1 Dec 2026. Try it live · docs

Test and verify

POST /v1/checks/a11y-snapshot

Accessibility Facts

A11y snapshots as browser facts. Violations, passes, and impact levels — structured for your pipeline, not qualitative scores.

What you can do with accessibility facts

ScoutAPI delivers a11y as structured raw data — either as a quick inventory (headings, links, landmarks) or a full axe run. No soft judgments, just facts for CI and agents.

  • A11y snapshot: inventories without an axe run
  • Raw axe violations including nodes and impact
  • Viewport controls what is visible and counted in the snapshot
  • Usable as a release gate or regression check in pipelines
API Call
editable
Request bodyJSON
{'{'}
:,
:,
:,
:
{'}'}

A11y snapshot: viewport changes inventories (headings, links, …).

—
Headings
—
Links
—
Buttons
—
Landmarks
Run to capture the live a11y payload.
No request yet
{
  "message": "Not run yet"
}

Endpoints & parameters

Pick an endpoint for a sample request and a clear list of parameters.

POST /v1/checks/a11y-snapshot

Structural a11y inventory (no axe violations).

Example request

{
  "url": "https://example.com",
  "width": 1280,
  "height": 720,
  "dismiss_cookie_banner": true
}

Parameters

NameTypeDescription
urlreqstringTarget URL.
width / heightnumberViewport — affects buttons, links, and landmarks in the snapshot.
settle_ms / goto_timeout_msnumberLoad and settle timeouts.
dismiss_cookie_bannerbooleanAttempts to dismiss known cookie banners before measuring or checking.
wait_for_selectorstringWaits for a CSS selector before continuing.
wait_ms / settle_msnumberAdditional wait time after loading (depends on endpoint).
devicestringPlaywright device preset; overrides width/height/UA when set.
color_scheme'light'|'dark'|'no-preference'Preferred color scheme in the browser.
block_adsbooleanBlocks known ad and tracker requests.
capture_xhrstringGlob or substring for XHR/fetch URLs whose bodies ScoutAPI captures (max. 20).
fetch_mode'browser'|'http'http loads without JavaScript (static document). Default: browser.
solve_captchabooleanOwned-site Cloudflare JS / Turnstile checkbox. Pair with stealth. Cloud: domain verify. Self-host: always allowed. Not an image-puzzle solver.
record_harbooleanOptionally records HAR (where supported by the endpoint).
respect_robotsbooleanRespect robots.txt (default: on).