What you get#
Onekey exposes On Page as 1 endpoint behind one API key: 1 endpoint return one record (data is an object). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for On Page also works for the rest of the ai & search category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
page | On-page SEO audit of one URL: status, title, description, canonical, score, size and timing. | url* | 2 | beta needs a pack |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls on_page.page (2 credits, beta). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/on_page/page?url=https%3A%2F%2Fexample.com%2F" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from On Page, with the same names as on every other platform. The count is how many of its 1 mapped endpoints return the field; a field the source lacks is null, never missing. 7 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
content.title | string | 1 |
entity.description | string | 1 |
entity.url | URL | 1 |
The full schema is in Unified schema.
Pricing#
Every On Page endpoint costs 2 credits per call. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.