Audit websites programmatically
Queue a real-browser website scan, poll until it finishes, then consume structured findings or share the finished report.
Authentication
Create an account in the Snapraven dashboard, then send your scanner key in the x-api-key header. Keep it server-side.
x-api-key: sr_...Endpoints
/v1/auditsQueue a website audit./v1/auditsList your latest website audits./v1/audits/:idGet an audit and its findings./v1/audits/:id/reportOpen the client-ready HTML report./v1/audits/:id/report.pdfDownload the client-ready audit report.1. Queue an audit
curl -X POST "https://api.snapraven.app/v1/audits" \
-H "x-api-key: sr_..." \
-H "content-type: application/json" \
-d '{"url":"https://example.com","authorityConfirmed":true}'authorityConfirmed records that you are authorized or otherwise legally permitted to audit the URL. The response is created with PENDING status; save its id.
2. Poll for completion
curl -H "x-api-key: sr_..." "https://api.snapraven.app/v1/audits/AUDIT_ID"Poll until the status becomes DONE or FAILED. Successful results include the health score and deterministic findings.
3. Open the report
Reports can be opened directly in your browser. Because browser navigation cannot set a custom header, the preview URL uses the key in its query string. Treat this URL as a credential: do not publish or send it to a client. Download the finished report and share the file instead.
https://api.snapraven.app/v1/audits/AUDIT_ID/report?key=sr_...