Free API

API

The API is free and needs no key. It is rate limited per IP (30 requests per minute, 100 new scans per hour, 600 per day). Responses are JSON. Cached results are free and do not count against scan limits.

Submit a file or a link

POST/api/v1/scan
1# upload a file
2curl -F file=@MyPlugin.jar https://virusmc.zeabur.app/api/v1/scan
3
4# or a link
5curl -H 'Content-Type: application/json' \
6  -d '{"url":"https://modrinth.com/plugin/example"}' https://virusmc.zeabur.app/api/v1/scan

Response: {"id":"…","sha256":"…","status":"queued|running|done","cached":false,"report_url":"…","status_url":"…"}. Add private=1 to keep the report unlisted.

Poll a scan

GET/api/v1/scan/:id

Returns status, stages and, while queued, queue (position, total, eta_seconds).

Get a report

GET/api/v1/report/:sha256
1curl https://virusmc.zeabur.app/api/v1/report/<sha256>

Returns the verdict, score, reasons, findings, capabilities, network data, libraries and AI notes. 404 if there is no public report.

Stats

GET/api/v1/stats

Totals computed from the database: total, mods, plugins, malicious, queue depth.

Other endpoints

Errors

Errors are JSON: {"error":"code","message":"…"} with HTTP 400, 404, 413, 429 or 503. On 429 read Retry-After.