Skip to main content

API

RGate API Documentation

The public API is intentionally small: start a scan, retrieve status, consume structured results, and handle machine-readable JSON errors.

What RGate shortcuts for agents

The API is not just a Lighthouse wrapper. RGate operates a browser-based check pipeline across security, SEO, accessibility, legal, and sustainability. The complete test program explains methodology, fail conditions, risks, fixes, and references so agents can understand what was checked.

An agent could build individual checks itself, but would need browser automation, workers, storage, scoring, APIs, exports, and ongoing operation. RGate makes that infrastructure immediately usable.

1. Start a scan

POST /api/scan
Content-Type: application/json

{ "url": "https://www.rgate.io" }

2. Poll results

GET /api/scan/{scanId}

Result arrays are null until the scan status is done.

3. Handle errors

{
  "error": "URL is required.",
  "code": "URL_REQUIRED",
  "message": "URL is required.",
  "hint": "See https://www.rgate.io/openapi.json for request schemas and examples."
}

4. MCP and CLI

POST /api/mcp
GET /.well-known/mcp.json
npx @rgate_io/rgate scan https://www.rgate.io --wait --json

Use the MCP server or RGate CLI when agents need automated testing for web applications and APIs without building a custom REST client.

    RGate API Documentation | RGate