Documentation
Everything you need to integrate with the On-Page SEO API. Start with the quickstart to make your first API call, then explore the reference guides as you build.
Interactive API Reference
Try every endpoint in your browser →
Paste your API key, hit an endpoint, see a live response. Generated from the same contract that serves OpenAPI 3.1 + SDK generators.
Recommended path
1. Quickstart — make your first API call and get a report back.
2. REST API Reference — learn every endpoint, request shape, and error code.
3. Report Schema — understand the 100kb+ JSON report your scans return.
4. Webhooks & Rate Limits — production essentials.
5. MCP Integration — let AI agents run scans and optimizations directly.
All guides
Quickstart
Start hereGo from signup to your first scan, poll, and report with copy-paste commands.
REST API Reference
Endpoint-by-endpoint request shapes, response examples, auth, errors, and code samples.
Authentication
Bearer API keys, permissions, organization scoping, and security best practices.
Report Schema
Understand the scan report layout, what each section means, and how to use the data for SEO.
Webhooks
Signed webhook delivery, retry behavior, health states, and test deliveries.
Rate Limits
Request limits, concurrent scan caps, queue behavior, and how to handle 429s.
MCP Integration
Install the MCP connector for Claude, Cursor, or Codex and let AI agents run scans directly.
SDK Generators
Generate a typed client (TypeScript, Python, and more) from our OpenAPI spec in one command.