Building permits
12mResidential & small commercial · walk-in Wed
Test and verify
POST /v1/checks/a11y-snapshot
A11y snapshots as browser facts. Violations, passes, and impact levels — structured for your pipeline, not qualitative scores.
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: viewport changes inventories (headings, links, …).
Pick an endpoint for a sample request and a clear list of parameters.
POST /v1/checks/a11y-snapshot
Structural a11y inventory (no axe violations).
{
"url": "https://example.com",
"width": 1280,
"height": 720,
"dismiss_cookie_banner": true
}| Name | Type | Description |
|---|---|---|
urlreq | string | Target URL. |
width / height | number | Viewport — affects buttons, links, and landmarks in the snapshot. |
settle_ms / goto_timeout_ms | number | Load and settle timeouts. |
dismiss_cookie_banner | boolean | Attempts to dismiss known cookie banners before measuring or checking. |
wait_for_selector | string | Waits for a CSS selector before continuing. |
wait_ms / settle_ms | number | Additional wait time after loading (depends on endpoint). |
device | string | Playwright device preset; overrides width/height/UA when set. |
color_scheme | 'light'|'dark'|'no-preference' | Preferred color scheme in the browser. |
block_ads | boolean | Blocks known ad and tracker requests. |
capture_xhr | string | Glob 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_captcha | boolean | Owned-site Cloudflare JS / Turnstile checkbox. Pair with stealth. Cloud: domain verify. Self-host: always allowed. Not an image-puzzle solver. |
record_har | boolean | Optionally records HAR (where supported by the endpoint). |
respect_robots | boolean | Respect robots.txt (default: on). |