What the API Provides
Scanning
Submit URLs for WCAG scanning and retrieve issue reports programmatically
Remediation
Submit HTML, URLs, or PDFs for AI-assisted remediation suggestions
Compliance Reports
Generate VPAT and compliance snapshot reports on demand
Features
Read available accessibility features and presets
Analytics
Retrieve feature usage statistics and widget engagement data
Webhooks
Receive real-time notifications when scans complete or issues are detected
Authentication
All API requests are authenticated using API keys passed in the X-Api-Key header. API keys are created and managed in your Angstroma portal.
curl https://api.angstroma.com/api/v1/scanner/submit \
-H "X-Api-Key: ak_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"url": "https://yourwebsite.com", "standard": "WCAG21_AA"}'Rate Limits
Rate limits are per API key, per plan, per month. They reset on your billing anniversary.
When you exceed rate limits, the API returns HTTP 429. Your monthly quota is shown in the portal and returned in response headers.
API Design Principles
RESTful JSON API
Standard HTTP methods (GET, POST, DELETE). All responses are JSON. Error responses include a code, message, and traceId.
Versioned endpoints
All endpoints are under /api/v1/. We will provide migration guides and deprecation notices before removing or changing endpoints.
Consistent error responses
HTTP 4xx and 5xx errors return a structured JSON body with error code, human-readable message, and a traceId for support requests.
No stack traces in responses
Error responses never include server stack traces or internal implementation details.
Idempotent where possible
Resource creation endpoints return the existing resource if called with the same identifier, reducing duplicate creation errors.
Start using the API
Create an account, generate an API key from the portal, and make your first request. API access is included in all paid plans.