Skip to main content

Accessibility API Reference

The A11yWatch Accessibility API can be used to gather multi page and cross domain vitals and other custom events. This is useful when trying to keep multi pages on a website inclusive using real browsers and workflows that cannot be detected simply by linting.

In most cases we recommend installing A11yWatch through one of the OpenAPI clients or the sidecar. However, if there's no easy way for you to integrate with A11yWatch, you can still do so by sending events directly to the API.

For a detailed document of the API visit A11yWatch API Page

Endpoints

Replace http://localhost:3280 with https://api.a11ywatch.com if using our remote service.

POST /api/crawl-stream

Perform a very fast multi-threaded crawl across your website for web accessibility and other critical web vitals. When using this endpoint, make sure you're sending the correct headers for authentication if using our remote API:

Authorization is used to authentication

curl -s --location --request POST 'http://localhost:3280/api/crawl-stream' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: $A11YWATCH_TOKEN' \
--data-urlencode 'websiteUrl=https://jeffmendez.com'
Post JSON body parameters
websiteUrl Required

The domain or url of the website to perform the initial crawl.