API reference

On-Page SEO Audit API

On-page SEO audit of one URL: title and meta description checks, heading structure, image alt coverage, internal/external links, canonical, robots meta, social tags, HTTPS, word count, and a severity-ranked findings list.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/on_page/pagelive · proven3 credits

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`url`	yes	Page URL to audit (http/https, public hosts only)	`https://example.com`
`timeout`	no	Fetch budget in milliseconds, clamped to 1000-15000	`10000`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/on_page/page?url=https%3A%2F%2Fexample.com" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/on_page/page?url=https%3A%2F%2Fexample.com",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/on_page/page?url=https%3A%2F%2Fexample.com",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "on_page",
  "endpoint": "/v1/on_page/page",
  "data": {
    "_warnings": [
      "example"
    ],
    "final_url": "https://example.com/example",
    "findings": [
      {
        "id": "example",
        "message": "example",
        "severity": "example"
      }
    ],
    "headings": {
      "counts": {
        "h1": 0,
        "h2": 0,
        "h3": 0,
        "h4": 0,
        "h5": 0,
        "h6": 0
      },
      "h1_count": 0,
      "outline": [
        {
          "level": 0,
          "text": "example"
        }
      ],
      "structure_ok": false
    },
    "https": false,
    "images": {
      "total": 0,
      "with_alt": 0,
      "without_alt": 0
    },
    "language": "example",
    "links": {
      "external": 0,
      "internal": 0,
      "total": 0
    },
    "meta_description": {
      "length": 0,
      "present": false
    },
    "open_graph": {
      "complete": false,
      "missing": [
        "example"
      ],
      "present": 0
    },
    "redirected": false,
    "robots": {
      "nofollow": false,
      "noindex": false
    },
    "status": 0,
    "title": {
      "length": 0,
      "present": false,
      "text": "example"
    },
    "twitter_card": {
      "complete": false,
      "missing": [
        "example"
      ],
      "present": 0
    },
    "url": "https://example.com/example",
    "viewport_meta": false,
    "word_count": 0
  },
  "credits_used": 3,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`canonical`	`string \| null`	Canonical URL returned by this audit when supplied.
`_warnings`	`array \| null`	Optional warnings supplied by this operation. Null means unknown.
`final_url`	`string \| null`	Optional final url supplied by this operation. Null means unknown.
`findings`	`array \| null`	Optional findings supplied by this operation. Null means unknown.
`findings[].id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`findings[].message`	`string \| null`	Optional message supplied by this operation. Null means unknown.
`findings[].severity`	`string \| null`	Optional severity supplied by this operation. Null means unknown.
`headings`	`object \| null`	Optional headings supplied by this operation. Null means unknown.
`headings.counts`	`object \| null`	Optional counts supplied by this operation. Null means unknown.
`headings.counts.h1`	`number \| null`	Optional h1 supplied by this operation. Null means unknown.
`headings.counts.h2`	`number \| null`	Optional h2 supplied by this operation. Null means unknown.
`headings.counts.h3`	`number \| null`	Optional h3 supplied by this operation. Null means unknown.
`headings.counts.h4`	`number \| null`	Optional h4 supplied by this operation. Null means unknown.
`headings.counts.h5`	`number \| null`	Optional h5 supplied by this operation. Null means unknown.
`headings.counts.h6`	`number \| null`	Optional h6 supplied by this operation. Null means unknown.
`headings.h1_count`	`number \| null`	Optional h1 count supplied by this operation. Null means unknown.
`headings.outline`	`array \| null`	Optional outline supplied by this operation. Null means unknown.
`headings.outline[].level`	`number \| null`	Optional level supplied by this operation. Null means unknown.
`headings.outline[].text`	`string \| null`	Source text when supplied.
`headings.structure_ok`	`boolean \| null`	Optional structure ok supplied by this operation. Null means unknown.
`https`	`boolean \| null`	Optional https supplied by this operation. Null means unknown.
`images`	`object \| null`	Optional images supplied by this operation. Null means unknown.
`images.total`	`number \| null`	Source-reported total; null is unknown.
`images.with_alt`	`number \| null`	Optional with alt supplied by this operation. Null means unknown.
`images.without_alt`	`number \| null`	Optional without alt supplied by this operation. Null means unknown.
`language`	`string \| null`	Optional language supplied by this operation. Null means unknown.
`links`	`object \| null`	Optional links supplied by this operation. Null means unknown.
`links.external`	`number \| null`	Optional external supplied by this operation. Null means unknown.
`links.internal`	`number \| null`	Optional internal supplied by this operation. Null means unknown.
`links.total`	`number \| null`	Source-reported total; null is unknown.
`meta_description`	`object \| null`	Optional meta description supplied by this operation. Null means unknown.
`meta_description.length`	`number \| null`	Optional length supplied by this operation. Null means unknown.
`meta_description.present`	`boolean \| null`	Optional present supplied by this operation. Null means unknown.
`open_graph`	`object \| null`	Optional open graph supplied by this operation. Null means unknown.
`open_graph.complete`	`boolean \| null`	Optional complete supplied by this operation. Null means unknown.
`open_graph.missing`	`array \| null`	Optional missing supplied by this operation. Null means unknown.
`open_graph.present`	`number \| null`	Optional present supplied by this operation. Null means unknown.
`redirected`	`boolean \| null`	Optional redirected supplied by this operation. Null means unknown.
`robots`	`object \| null`	Optional robots supplied by this operation. Null means unknown.
`robots.nofollow`	`boolean \| null`	Optional nofollow supplied by this operation. Null means unknown.
`robots.noindex`	`boolean \| null`	Optional noindex supplied by this operation. Null means unknown.
`status`	`number \| null`	Optional status supplied by this operation. Null means unknown.
`title`	`object \| null`	Source title when supplied.
`title.length`	`number \| null`	Optional length supplied by this operation. Null means unknown.
`title.present`	`boolean \| null`	Optional present supplied by this operation. Null means unknown.
`title.text`	`string \| null`	Source text when supplied.
`twitter_card`	`object \| null`	Optional twitter card supplied by this operation. Null means unknown.
`twitter_card.complete`	`boolean \| null`	Optional complete supplied by this operation. Null means unknown.
`twitter_card.missing`	`array \| null`	Optional missing supplied by this operation. Null means unknown.
`twitter_card.present`	`number \| null`	Optional present supplied by this operation. Null means unknown.
`url`	`string \| null`	Original source URL when supplied.
`viewport_meta`	`boolean \| null`	Optional viewport meta supplied by this operation. Null means unknown.
`word_count`	`number \| null`	Optional word count supplied by this operation. Null means unknown.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

On-Page SEO Audit API

Query parameters

Make the request

Response fields and example

More On-Page reference

First call in under a minute