Public API

Run a free preview from your own tools and receive each result the moment it is ready. Described in OpenAPI 3.1.

Download openapi.json Try it in the browser

GET/api/v1/scans/stream?url={website}&market={US|GB|CA|AU|IE}

Runs a free preview of a public website and streams Server-Sent Events. Events: accepted, scan_started, check, page, tree, summary, scan_complete, scan_error. Each event’s data is JSON.

curlexample

curl -N "https://visibility.arcvanelabs.com/api/v1/scans/stream?url=example.com"

response · text/event-streamone event

event: check data: {"id":"names","layer":"use","state":"bad","label":"3 unnamed", "title":"Buttons and links have names","detail":"…","fix":"…","t":43}

Errors

Error codes
HTTP	code	Meaning
400	`invalid_url`, `blocked_address`, `blocked_port`	Not a public website address
429	`rate_limited`	Too many checks from your network; wait for the time in `Retry-After`
503	`scans_paused`	Checks are paused for maintenance

GET/api/v1/scans/{id}

Returns a saved preview as JSON. Saved previews are kept for 30 days. The id arrives in the scan_complete event.

GET/api/v1/health

Service status.

Result states

Every check has a state: ok warn bad na info, a short label, a plain-language detail and, where useful, a suggested fix. The summary event gives the Find, Understand, Use and AI answers states. There is no single score. What the states mean

Partner and enterprise plans include authenticated access, saved projects and webhooks. Talk to us