# On Page on Onekey

> 1 endpoint for On Page (0 stable, 1 beta), 2 credits each. Category: AI & search. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 1 of 1 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/on_page
Reference (Markdown): https://onekey.dev/docs/api/on_page.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 1 mapped On Page endpoints return each:

- `content.title` (string): 1
- `entity.description` (string): 1
- `entity.url` (URL): 1
- plus 7 platform-specific fields under `ext.`

## Endpoints

### on_page.page

On-page SEO audit of one URL: status, title, description, canonical, score, size and timing.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/on_page/page?url=https%3A%2F%2Fexample.com%2F` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Absolute page URL to audit, including https://
- Fields returned: `entity.url`, `content.title`, `entity.description`, `ext.canonical`, `ext.statusCode`, `ext.onpageScore`, `ext.sizeBytes`, `ext.pageTiming`, `ext.checks`, `ext.wordCount`
- Reference: https://onekey.dev/docs/api/on_page/page.md

## Sample request

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