Web Accessibility API

The web accessibility API designed to scale.

To get started with the A11yWatch API add your authorization header with the JWT format Bearer TOKEN. For more information go to the OpenAPI, GraphQL, or gRPC documentation. You need a paid subscription in order to access the API.

Authentication & User
- https://api.a11ywatch.com/api/user
  GET
  curl --location --request GET 'https://api.a11ywatch.com/api/user' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/login
  POST
  email stringThe email account to login with.Requiredpassword stringThe password to the email to login with.Required
  curl --location --request POST 'https://api.a11ywatch.com/api/login' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "email": "example@email.com", "password": "somethingsafe" }'
Report Actions
- https://api.a11ywatch.com/api/scan
  POST
  url stringThe url to crawl and gather reports.Required
  curl --location --request POST 'https://api.a11ywatch.com/api/scan' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/crawl
  POST
  url stringThe url to crawl and gather reports.Requiredsubdomains booleanInclude subdomains that match domain.sitemap numberInclude sitemap links - 0 disabled, 1 crawl only the sitemap, and 2 extend crawl with sitemap.tld booleanInclude all TLD extensions that match domain.csv header [Accept: text/csv]Handle data as CSV instead of JSON.standard stringThe web accessibility standard. One of WCAGA, WCAGAA, or WCAGAAA.language stringThe language in which to return the audit results can be one of the following: da (“Danish”), de (“German”), es (“Spanish”), ja (“Japanese”), eu (“Basque”), fr (“French”), ar (“Arabic”), ko (“Korean”), he (“Hebrew”), nl (“Dutch”), no-NB (“Norwegian”), pl (“Polish”), pt-BR (“Portuguese Brazil”), zh-CN (“Chinese-Simplified”), or zh-TW (“Chinese-Traditional”).pageScanLimit numberSet a limit of pages to crawl.
  curl --location --request POST 'https://api.a11ywatch.com/api/crawl' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/websites-sync
  POST
  curl --location --request POST 'https://api.a11ywatch.com/api/websites-sync' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json'
Website Management
- https://api.a11ywatch.com/api/website
  POST
  url stringThe website url.RequiredcustomHeaders string[{key: string, value: string}]An array of objects with key:value pair for header configurations.mobile booleanIs the testing done in mobile viewport?standard stringThe WCAG2.1 standard to use ex: WCAG2A, WCAG2AA, and WCAG2AAA.
  curl --location --request POST 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "websiteUrl": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website?domain=https://mywebsite.com
  GET
  url stringThe website url.Required
  curl --location --request GET 'https://api.a11ywatch.com/api/website?domain=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website
  PUT
  url stringThe website url.RequiredcustomHeaders string[{key: string, value: string}]An array of objects with key:value pair for header configurations.mobile booleanIs the testing done in mobile viewport?standard stringThe WCAG2.1 standard to use ex: WCAG2A, WCAG2AA, and WCAG2AAA.
  curl --location --request PUT 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website
  DELETE
  url The website url.domain stringThe name of the website.deleteMany booleanDelete all websites and related data.
  curl --location --request DELETE 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "domain": "a11ywatch.com" }'
- https://api.a11ywatch.com/api/report?url=https://mywebsite.com
  GET
  url The url to crawl and gather reports.Requireddownload booleanDownload the report to excel.csv booleanHandle data as CSV instead of JSON.
  curl --location --request GET 'https://api.a11ywatch.com/api/report?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com
  GET
  url The website url.Required
  curl --location --request GET 'https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com
  GET
  url The url to crawl and gather reports.Required
  curl --location --request GET 'https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
List Results
- https://api.a11ywatch.com/api/list/website?offset=0
  GET
  offset numberThe page position to get the next set paginated.search stringSearch for a url record match.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/website?offset=0' --header 'Authorization: $A11YWATCH_TOKEN' undefined
- https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com
  GET
  offset numberThe page position to get the next set paginated.domain stringThe name of the website.search stringSearch for a url record match.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/pages?offset=0
  GET
  offset numberThe page position to get the next set paginated.domain stringThe name of the website.search stringSearch for a url record match.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/pages?offset=0' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com
  GET
  offset numberThe page position to get the next set paginated.domain stringThe name of the website.pageUrl stringThe website url.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'

By default, the A11yWatch API docs demonstrate using curl to interact with the API over HTTP. Most routes allow params to be sent from the url or the body. It's best to stick to using the body for http PUT and POST request since some params are set to be arrays and other none string shapes. In the example, replace https://mywebsite.com with the website you want to target. Using A11yWatch on a CI can drastically save development costs by raising awareness before production deployment.

Stay inclusive with confidence

Get started with A11yWatch now for affordable and speedy automated web accessibility tools.

Get started now

Web Accessibility API

The web accessibility API designed to scale.

Authentication & User

Report Actions

Website Management

List Results

Stay inclusive with confidence