Docs›API Access

API Access Coming soon

Programmatic access to the Nel404 Health scanner is planned for the Agency tier. This page outlines the intended design - nothing is live yet.

API not yet live

We are building the API. If programmatic access is important for your workflow, register your interest and we will email you when it launches.

Notify me at launch

Planned availability

API access will be included in the Agency tier (R1 199/year). It will not be available on Starter (once-off) or Solo (monthly) plans. Rate limits will apply to prevent abuse.

Authentication (planned)

The API will use Bearer token authentication. After subscribing to the Agency tier, you will be able to generate an API key from your account dashboard. Include it in every request:

Authorization: Bearer nel_live_xxxxxxxxxxxxxxxxxxxxxx

Planned endpoints

POST /api/v1/scans Submit a URL for scanning
GET /api/v1/scans/{scan_id} Poll scan status and retrieve results
GET /api/v1/scans/{scan_id}/report Download the PDF report
GET /api/v1/domains List your registered domains
GET /api/v1/domains/{domain}/history Score history for a domain

Planned response format

All endpoints will return JSON. A scan result will look something like:

{
  "scan_id": "sc_01hwxyz",
  "url": "https://example.co.za",
  "status": "complete",
  "scores": {
    "overall": 74,
    "performance": 68,
    "seo": 82,
    "security": 55,
    "accessibility": 79,
    "mobile": 90,
    "best_practices": 71
  },
  "findings_count": 12,
  "report_url": "https://health.nel404labs.co.za/api/v1/scans/sc_01hwxyz/report",
  "scanned_at": "2026-05-11T10:32:00+02:00"
}

Rate limits (planned)

Need more capacity? Contact hello@nel404labs.co.za for an enterprise arrangement.

← Scheduled scans Docs home →