{"url":"https://example.com/","timestamp":"2026-04-09T15:33:16.357Z","summary":{"score":98,"grade":"A","totalIssues":4,"errors":0,"warnings":3,"infos":1,"categorySummary":[{"name":"Images & Alt Text","score":100,"issueCount":0},{"name":"Headings","score":100,"issueCount":0},{"name":"Forms","score":100,"issueCount":0},{"name":"Links & Navigation","score":90,"issueCount":2},{"name":"Color Contrast","score":100,"issueCount":0},{"name":"ARIA","score":100,"issueCount":0},{"name":"Language","score":100,"issueCount":0},{"name":"Tables","score":100,"issueCount":0},{"name":"Media","score":100,"issueCount":0},{"name":"Semantic HTML","score":93,"issueCount":2}]},"categories":[{"name":"Images & Alt Text","score":100,"issues":[]},{"name":"Headings","score":100,"issues":[]},{"name":"Forms","score":100,"issues":[]},{"name":"Links & Navigation","score":90,"issues":[{"rule":"links-generic-text","severity":"warning","message":"Link has generic text: \"Learn more\"","element":"<a href=\"https://iana.org/domains/example\">Learn more</a>","wcag":"2.4.4","suggestion":"Use descriptive link text that explains the destination or purpose (e.g., \"View pricing details\" instead of \"Click here\")."},{"rule":"links-no-skip-nav","severity":"warning","message":"Page has no skip navigation link","element":"<body>","wcag":"2.4.1","suggestion":"Add a skip navigation link at the top of the page (e.g., <a href=\"#main\">Skip to main content</a>)."}]},{"name":"Color Contrast","score":100,"issues":[]},{"name":"ARIA","score":100,"issues":[]},{"name":"Language","score":100,"issues":[]},{"name":"Tables","score":100,"issues":[]},{"name":"Media","score":100,"issues":[]},{"name":"Semantic HTML","score":93,"issues":[{"rule":"semantic-no-main-landmark","severity":"warning","message":"Page has no <main> landmark","element":"<body>","wcag":"1.3.1","suggestion":"Add a <main> element to wrap the primary content of the page."},{"rule":"semantic-no-nav-landmark","severity":"info","message":"Page has no <nav> landmark","element":"<body>","wcag":"1.3.1","suggestion":"Add a <nav> element to identify navigation sections."}]}],"recommendations":[]}
curl --location --request GET 'https://zylalabs.com/api/12322/accessibility+audit+api/23147/run+accessibility+audit?url=https://example.com' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Accessibility Audit API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Run automated WCAG accessibility audits on any web page. Detects violations, warnings, and best practices for ADA and EAA compliance.
The Accessibility Audit API can detect various types of accessibility violations, including issues related to color contrast, missing alt text for images, improper heading structures, and other WCAG compliance failures.
The Accessibility Audit API provides output in JSON format, which includes detailed reports on violations, warnings, and best practices for accessibility compliance.
You can integrate the Accessibility Audit API into your web development workflow by running audits on your web pages during the development phase to identify and fix accessibility issues before deployment.
The core benefits of using the Accessibility Audit API include improving website accessibility for users with disabilities, ensuring compliance with ADA and EAA regulations, and enhancing overall user experience.
The API's audit reports include fields such as 'violation type', 'description', 'impact level', 'element affected', and 'suggested fixes', providing comprehensive insights into accessibility issues.
The Accessibility Audit API returns data related to accessibility violations, warnings, and best practices for web pages. This includes a summary score, detailed category scores, and specific issues identified during the audit.
The response data is structured in JSON format, featuring a summary section with overall scores, a category summary with individual scores and issue counts, and detailed lists of issues for each category, including severity and suggested fixes.
The primary parameter for the Accessibility Audit API is the URL of the web page to be audited. Users can customize their requests by specifying different URLs to analyze various pages for accessibility compliance.
Key fields include 'score' (overall accessibility score), 'grade' (letter grade for compliance), 'totalIssues' (total number of issues found), and 'issues' (specific problems identified, including severity and messages).
The endpoint provides information on accessibility violations, warnings, and best practices, categorized by areas such as Images & Alt Text, Headings, and Color Contrast, allowing users to pinpoint specific compliance issues.
Users can utilize the returned data to prioritize fixes based on severity and category scores, implement recommended changes, and track improvements over time by comparing audit results across different versions of their web pages.
Data accuracy is maintained through adherence to WCAG guidelines and regular updates to the auditing algorithms, ensuring that the API reflects current best practices and compliance standards for web accessibility.
Typical use cases include running audits during web development to identify accessibility issues, conducting compliance checks for existing websites, and generating reports for stakeholders to demonstrate adherence to accessibility standards.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund