on_page.page

beta 2 credits needs a pack

On-page SEO audit of one URL: status, title, description, canonical, score, size and timing.

GET /v1/on_page/page

What you get#

One On Page record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

Also known as: /on_page/page on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

2 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`url`	string	yes	(required)	Absolute page URL to audit, including https://	max 500 chars; must match `https?://[^\s"'<>]{4,490}`; trimmed

Request#

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

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real On Page response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "url": "https://example.com/",
      "description": "An example page."
    },
    "content": {
      "title": "Example Domain"
    },
    "ext": {
      "canonical": "https://example.com/",
      "statusCode": 200,
      "onpageScore": 94.5,
      "sizeBytes": 1256,
      "pageTiming": {
        "time_to_interactive": 120,
        "dom_complete": 180,
        "largest_contentful_paint": 150
      },
      "checks": {
        "no_title": false,
        "is_https": true,
        "no_description": false
      },
      "wordCount": 28
    }
  },
  "metadata": {
    "platform": "on_page",
    "endpoint": "page",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`url`	`entity.url`	`safeUrl`
`meta.title`	`content.title`	-
`meta.description`	`entity.description`	-
`meta.canonical`	`ext.canonical`	-
`status_code`	`ext.statusCode`	`toNumber`
`onpage_score`	`ext.onpageScore`	`toNumber`
`size`	`ext.sizeBytes`	`toNumber`
`page_timing`	`ext.pageTiming`	-
`checks`	`ext.checks`	-
`content.plain_text_word_count`	`ext.wordCount`	`toNumber`

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 2 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).