API

REST API

Run scans from CI, your backend, or a Zapier workflow.

Endpoints

MethodPathPurpose
POST/api/public/scanStart a new scan
GET/api/public/scan/:idPoll for results
GET/api/public/badge/:idReturn the SVG badge

Start a scan

bash
curl -X POST https://magneticwp.com/api/public/scan \ -H "Content-Type: application/json" \ -d '{ "url": "https://yoursite.com", "isPublic": true }'

Response shape

json
{ "id": "sc_01HXYZ...", "status": "complete", "grade": "B", "score": 82, "dimensions": { "discoverability": 92, "content": 78, "bot_access": 80, "capabilities": 70 }, "checks": [ { "id": "D1", "status": "pass", "weight": 6 }, { "id": "B1", "status": "fail", "weight": 8, "detail": "GPTBot blocked" } ] }
Rate limits
Public endpoint: 10 scans / hour / IP. Sign in and use an API key to raise this to 100 scans / hour. Contact us for higher limits.