Skip to content
Back to home

Scan API — free accessibility scanning endpoint

Last updated: 2026-09-09 · This English version is the binding version of this document.

FixRamp exposes the same scanning engine the website uses as a simple JSON API. It runs your target page in a real headless browser, executes axe-core with WCAG 2.1/2.2 AA rule sets, and returns structured violations. No API key required for fair use (rate limited to 6 scans per minute per IP).

Run a scan

POST https://fixramp.zalize.com/api/scan
Content-Type: application/json

{"url": "https://example.com", "crawl": false}

Set "crawl": true to scan up to 5 same-origin pages. Responses are cached for one hour per URL.

Response shape

{
  "id": "ab12cd34-567",        // report id — shareable at /r/{id}
  "url": "https://example.com/",
  "score": 87,                  // 0-100 weighted compliance score
  "totalNodes": 12,             // failing elements
  "violationTypes": 4,          // distinct failed rules
  "pages": [{
    "url": "...",
    "score": 87,
    "violations": [{
      "id": "color-contrast",
      "impact": "serious",      // critical | serious | moderate | minor
      "help": "...", "helpUrl": "...",
      "tags": ["wcag2aa", "wcag143"],
      "disabilities": ["Low vision"],
      "nodes": [{ "html": "...", "target": ["css > selector"] }]
    }],
    "incomplete": [...],        // needs human review
    "passes": [...]
  }]
}

Retrieve a stored report

GET https://fixramp.zalize.com/api/scan/{id}

Reports are retained for 30 days. A PDF audit of any report is available at /api/report.pdf?id={id}, and an embeddable SVG badge (score + scan date, links back to the public report) at /api/badge/{id}. The badge states the automated score only — it is not a compliance certificate.

Fair use

  • 6 scans per minute per IP; 429 with Retry-After when exceeded.
  • If the target answers with a bot-protection challenge or an access-denied page, the API returns 422 { "error": "target_blocked", "reason": "..." } instead of grading the block page; HTTP 4xx/5xx targets return 422 target_http_error.
  • Only scan sites you own or are authorised to test.
  • Automated results cover roughly 30–57% of WCAG issues; manual review is still required for full compliance.

Questions or higher-volume needs? Reach out via the contact page.