100 free credits. No credit card required.Start building
Logo
On-Page logo
100 free credits. No credit card required

On-Page Page API

Returns a technical on-page SEO audit for one URL: title, meta, heading counts, on-page score, checks, and page timing.

GET /v1/on_page/page

Last updated November 2026Maintained by the SocialCrawl team

When to use the On-Page Page API

Use it to audit a single public URL in one call rather than crawling a whole site.

From the API reference

Returns a technical on-page audit for one URL: title, meta, heading counts, on-page score, checks (HTTPS, canonical, broken links), and page timing. One credit per call.

Searching 69 platforms in parallel

·TikTok logoTikTok·Instagram logoInstagram·YouTube logoYouTube·Facebook logoFacebook·X logoX·LinkedIn logoLinkedIn·Reddit logoReddit·Threads logoThreads·Pinterest logoPinterest·Twitch logoTwitch·Truth Social logoTruth Social·Snapchat logoSnapchat·Kick logoKick·Bluesky logoBluesky·Kwai logoKwai·Rumble logoRumble·Spotify logoSpotify·Apple Music logoApple Music·TikTok Shop logoTikTok Shop·Amazon Shop logoAmazon Shop·Google Shopping logoGoogle Shopping·Trustpilot logoTrustpilot·TripAdvisor logoTripAdvisor·Yelp logoYelp·Linktree logoLinktree·Komi logoKomi·Pillar logoPillar·lnk.bio logolnk.bio·Facebook Ads logoFacebook Ads·Google Ads logoGoogle Ads·LinkedIn Ads logoLinkedIn Ads·Google Search logoGoogle Search·Google News logoGoogle News·Finance logoFinance·Polymarket logoPolymarket·Tavily logoTavily·Hacker News logoHacker News·GitHub logoGitHub·Perplexity logoPerplexity·Naver logoNaver·Utility logoUtility·Universal Search logoUniversal Search
·TikTok logoTikTok·Instagram logoInstagram·YouTube logoYouTube·Facebook logoFacebook·X logoX·LinkedIn logoLinkedIn·Reddit logoReddit·Threads logoThreads·Pinterest logoPinterest·Twitch logoTwitch·Truth Social logoTruth Social·Snapchat logoSnapchat·Kick logoKick·Bluesky logoBluesky·Kwai logoKwai·Rumble logoRumble·Spotify logoSpotify·Apple Music logoApple Music·TikTok Shop logoTikTok Shop·Amazon Shop logoAmazon Shop·Google Shopping logoGoogle Shopping·Trustpilot logoTrustpilot·TripAdvisor logoTripAdvisor·Yelp logoYelp·Linktree logoLinktree·Komi logoKomi·Pillar logoPillar·lnk.bio logolnk.bio·Facebook Ads logoFacebook Ads·Google Ads logoGoogle Ads·LinkedIn Ads logoLinkedIn Ads·Google Search logoGoogle Search·Google News logoGoogle News·Finance logoFinance·Polymarket logoPolymarket·Tavily logoTavily·Hacker News logoHacker News·GitHub logoGitHub·Perplexity logoPerplexity·Naver logoNaver·Utility logoUtility·Universal Search logoUniversal Search
·TikTok logoTikTok·Instagram logoInstagram·YouTube logoYouTube·Facebook logoFacebook·X logoX·LinkedIn logoLinkedIn·Reddit logoReddit·Threads logoThreads·Pinterest logoPinterest·Twitch logoTwitch·Truth Social logoTruth Social·Snapchat logoSnapchat·Kick logoKick·Bluesky logoBluesky·Kwai logoKwai·Rumble logoRumble·Spotify logoSpotify·Apple Music logoApple Music·TikTok Shop logoTikTok Shop·Amazon Shop logoAmazon Shop·Google Shopping logoGoogle Shopping·Trustpilot logoTrustpilot·TripAdvisor logoTripAdvisor·Yelp logoYelp·Linktree logoLinktree·Komi logoKomi·Pillar logoPillar·lnk.bio logolnk.bio·Facebook Ads logoFacebook Ads·Google Ads logoGoogle Ads·LinkedIn Ads logoLinkedIn Ads·Google Search logoGoogle Search·Google News logoGoogle News·Finance logoFinance·Polymarket logoPolymarket·Tavily logoTavily·Hacker News logoHacker News·GitHub logoGitHub·Perplexity logoPerplexity·Naver logoNaver·Utility logoUtility·Universal Search logoUniversal Search
·TikTok logoTikTok·Instagram logoInstagram·YouTube logoYouTube·Facebook logoFacebook·X logoX·LinkedIn logoLinkedIn·Reddit logoReddit·Threads logoThreads·Pinterest logoPinterest·Twitch logoTwitch·Truth Social logoTruth Social·Snapchat logoSnapchat·Kick logoKick·Bluesky logoBluesky·Kwai logoKwai·Rumble logoRumble·Spotify logoSpotify·Apple Music logoApple Music·TikTok Shop logoTikTok Shop·Amazon Shop logoAmazon Shop·Google Shopping logoGoogle Shopping·Trustpilot logoTrustpilot·TripAdvisor logoTripAdvisor·Yelp logoYelp·Linktree logoLinktree·Komi logoKomi·Pillar logoPillar·lnk.bio logolnk.bio·Facebook Ads logoFacebook Ads·Google Ads logoGoogle Ads·LinkedIn Ads logoLinkedIn Ads·Google Search logoGoogle Search·Google News logoGoogle News·Finance logoFinance·Polymarket logoPolymarket·Tavily logoTavily·Hacker News logoHacker News·GitHub logoGitHub·Perplexity logoPerplexity·Naver logoNaver·Utility logoUtility·Universal Search logoUniversal Search
On-Page API

What can you do with the Page API?

The Page endpoint gives you structured On-Page data with computed fields in a single request. No scraping infrastructure to build or maintain.

Example Request

# GET /v1/on_page/page: 1 credit per call. Cache hits are free and failed calls are refunded.
# Check the price first for 0 credits: add dry_run=1 to the query. Nothing is fetched or charged.
# --max-time 60: the API's own time limit for this endpoint.
# --retry 3: retries timeouts, 429 and 5xx, honoring Retry-After.
# -o response.json keeps only the final attempt's body.
# One Idempotency-Key per request, reused on every retry, so a retried call is never charged twice.
IDEMPOTENCY_KEY=$(od -An -N16 -tx1 /dev/urandom | tr -d ' \n')
curl -sS --max-time 60 --retry 3 -o response.json \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://www.socialcrawl.dev/v1/on_page/page?url=https%3A%2F%2Fwww.socialcrawl.dev%2F" && cat response.json
# GET /v1/on_page/page: 1 credit per call. Cache hits are free and failed calls are refunded.
# Check the price first for 0 credits: add dry_run=1 to the query. Nothing is fetched or charged.
import os
import random
import time
import uuid

import requests

API_KEY = os.environ.get("SOCIALCRAWL_API_KEY", "YOUR_API_KEY")
TIMEOUT_S = 60  # the API's own time limit for this endpoint.
MAX_RETRIES = 3
URL = "https://www.socialcrawl.dev/v1/on_page/page"


def backoff(attempt):
    # Exponential backoff with jitter: about 1 s, 2 s, then 4 s.
    return 2 ** attempt * (0.5 + random.random() / 2)


def socialcrawl(params):
    # One Idempotency-Key per request, reused on every retry, so a retried call is never charged twice.
    idempotency_key = str(uuid.uuid4())
    for attempt in range(MAX_RETRIES + 1):
        try:
            res = requests.get(
                URL,
                params=params,
                headers={"x-api-key": API_KEY, "Idempotency-Key": idempotency_key},
                timeout=TIMEOUT_S,
            )
            body = res.json()
        except (requests.RequestException, ValueError):
            # A timeout, a dropped connection or a non-JSON gateway page: retry with the same key.
            if attempt == MAX_RETRIES:
                raise
            time.sleep(backoff(attempt))
            continue
        if body["success"]:
            return body
        error = body["error"]
        # Branch on error["type"], never on the message text.
        if error["type"] == "RESOURCE_NOT_FOUND":
            return None  # refunded: nothing to read
        retry_after = res.headers.get("Retry-After")
        # SERVICE_UNAVAILABLE without Retry-After is a withdrawn endpoint: permanent.
        permanent = error["type"] == "SERVICE_UNAVAILABLE" and retry_after is None
        if not error.get("retryable") or permanent or attempt == MAX_RETRIES:
            raise RuntimeError(f"{error['type']}: {error['message']} (request_id {body['request_id']})")
        # Retry-After (seconds) wins; otherwise back off.
        time.sleep(float(retry_after) if retry_after else backoff(attempt))


params = {
    "url": "https://www.socialcrawl.dev/",
}
body = socialcrawl(params)
if body is not None:
    print(body["data"])
// GET /v1/on_page/page: 1 credit per call. Cache hits are free and failed calls are refunded.
// Check the price first for 0 credits: add dry_run=1 to the query. Nothing is fetched or charged.
const API_KEY = process.env.SOCIALCRAWL_API_KEY ?? "YOUR_API_KEY";
const TIMEOUT_MS = 60_000; // the API's own time limit for this endpoint.
const MAX_RETRIES = 3;

type Page = { next_cursor: string | null; has_more: boolean };
type SocialCrawlResponse =
  | { success: true; data: any; pagination?: Page; credits_used: number; request_id: string }
  | { success: false; error: { type: string; message: string; retryable: boolean }; request_id: string };

const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
// Exponential backoff with jitter: about 1 s, 2 s, then 4 s.
const backoffMs = (attempt: number) => 2 ** attempt * 1000 * (0.5 + Math.random() / 2);

async function socialcrawl(url: URL) {
  // One Idempotency-Key per request, reused on every retry, so a retried call is never charged twice.
  const idempotencyKey = crypto.randomUUID();
  for (let attempt = 0; ; attempt++) {
    let res: Response;
    let body: SocialCrawlResponse;
    try {
      res = await fetch(url, {
        headers: {
          "x-api-key": API_KEY,
          "Idempotency-Key": idempotencyKey,
        },
        signal: AbortSignal.timeout(TIMEOUT_MS),
      });
      body = (await res.json()) as SocialCrawlResponse;
    } catch (error) {
      // A timeout, a dropped connection or a non-JSON gateway page: retry with the same key.
      if (attempt >= MAX_RETRIES) throw error;
      await sleep(backoffMs(attempt));
      continue;
    }
    if (body.success) return body;
    // Branch on error.type, never on the message text.
    if (body.error.type === "RESOURCE_NOT_FOUND") return null; // refunded: nothing to read
    const retryAfter = res.headers.get("Retry-After");
    // SERVICE_UNAVAILABLE without Retry-After is a withdrawn endpoint: permanent.
    const permanent = body.error.type === "SERVICE_UNAVAILABLE" && retryAfter === null;
    if (!body.error.retryable || permanent || attempt >= MAX_RETRIES) {
      throw new Error(`${body.error.type}: ${body.error.message} (request_id ${body.request_id})`);
    }
    // Retry-After (seconds) wins; otherwise back off.
    await sleep(retryAfter ? Number(retryAfter) * 1000 : backoffMs(attempt));
  }
}

const url = new URL("https://www.socialcrawl.dev/v1/on_page/page");
url.searchParams.set("url", "https://www.socialcrawl.dev/");

const body = await socialcrawl(url);
if (body) console.log(body.data);

Parameters

ParameterRequiredDescription
urlYesAbsolute page URL to audit, including https://.
enable_javascriptNoSet true to execute JavaScript while loading the page. Default false.
Example Response

What does the On-Page Page API return?

Every response follows one unified schema. Here is a real, unmodified response body, so you can see the exact fields you get back before spending a credit.

Example response
{
  "success": true,
  "platform": "on_page",
  "endpoint": "/v1/on_page/page",
  "data": {
    "resource_type": "html",
    "status_code": 200,
    "location": null,
    "url": "https://www.socialcrawl.dev/",
    "meta": {
      "title": "Social Media Scraper API: 67 Platforms | SocialCrawl",
      "charset": 65001,
      "follow": true,
      "generator": null,
      "htags": {
        "h3": [
          "Solutions",
          "Tools"
        ],
        "h1": [
          "One scraper API for every social platform"
        ],
        "h2": [
          "Build with AI",
          "The unified social media scraping API for developers"
        ]
      },
      "description": "The social media scraper API: one schema, 631 endpoints, 67 platforms. MCP-ready, no compute units, no subscriptions. Start with 100 free credits, no card.",
      "favicon": "https://www.socialcrawl.dev/favicon.ico?favicon.36rp_lf50_-9y.ico",
      "meta_keywords": "social media scraper,social media API,social media scraping API,scrape social media data,social media data API,unified social media API,tiktok scraper API,instagram scraper API,social media data extraction,social media scraper API",
      "canonical": "https://www.socialcrawl.dev/",
      "internal_links_count": 89,
      "external_links_count": 11,
      "inbound_links_count": 0,
      "images_count": 49,
      "images_size": 0,
      "scripts_count": 54,
      "scripts_size": 0,
      "stylesheets_count": 0,
      "stylesheets_size": 0,
      "title_length": 52,
      "description_length": 155,
      "render_blocking_scripts_count": 1,
      "render_blocking_stylesheets_count": 0,
      "cumulative_layout_shift": 0,
      "meta_title": null,
      "content": {
        "plain_text_size": 11551,
        "plain_text_rate": 0.00339632006031107,
        "plain_text_word_count": 1864,
        "automated_readability_index": 9.88593027150753,
        "coleman_liau_readability_index": 11.47093362115488,
        "dale_chall_readability_index": 9.398847192809423,
        "flesch_kincaid_readability_index": 52.741162816122966,
        "smog_readability_index": 11.173244422047542,
        "description_to_content_consistency": 0.95652174949646,
        "title_to_content_consistency": 1,
        "meta_keywords_to_content_consistency": 0.9090909361839294
      },
      "deprecated_tags": null,
      "duplicate_meta_tags": [
        "theme-color"
      ],
      "spell": null,
      "social_media_tags": {
        "og:title": "Social Media Scraper API: 67 Platforms",
        "og:description": "The social media scraper API: one schema, 631 endpoints, 67 platforms. MCP-ready, no compute units, no subscriptions. Start with 100 free credits, no card.",
        "og:url": "https://www.socialcrawl.dev",
        "og:site_name": "SocialCrawl",
        "og:image": "https://www.socialcrawl.dev/opengraph-image.png",
        "og:image:width": "1200",
        "og:image:height": "630",
        "og:image:alt": "SocialCrawl",
        "og:type": "website",
        "twitter:card": "summary_large_image",
        "twitter:title": "Social Media Scraper API: 67 Platforms",
        "twitter:description": "The social media scraper API: one schema, 631 endpoints, 67 platforms. MCP-ready, no compute units, no subscriptions. Start with 100 free credits, no card.",
        "twitter:image": "https://www.socialcrawl.dev/opengraph-image.png",
        "twitter:image:alt": "SocialCrawl",
        "twitter:image:width": "1200",
        "twitter:image:height": "630"
      }
    },
    "page_timing": {
      "time_to_interactive": 234,
      "dom_complete": 234,
      "largest_contentful_paint": 0,
      "first_input_delay": 0,
      "connection_time": 7,
      "time_to_secure_connection": 28,
      "request_sent_time": 0,
      "waiting_time": 0,
      "download_time": 199,
      "duration_time": 234,
      "fetch_start": 0,
      "fetch_end": 234
    },
    "onpage_score": 91.59,
    "total_dom_size": 3401689,
    "custom_js_response": null,
    "custom_js_client_exception": null,
    "resource_errors": {
      "errors": [
        {
          "line": 30,
          "column": 28986,
          "message": "The closing tag and the currently open tag do not match.",
          "status_code": 501
        }
      ],
      "warnings": [
        {
          "line": 1,
          "column": 232,
          "message": "Has node with more than 60 childs.",
          "status_code": 1
        },
        {
          "line": 0,
          "column": 0,
          "message": "Has more that 1500 nodes.",
          "status_code": 2
        }
      ]
    },
    "broken_resources": false,
    "broken_links": false,
    "duplicate_title": false,
    "duplicate_description": false,
    "duplicate_content": false,
    "click_depth": 0,
    "size": 3401689,
    "encoded_size": 0,
    "total_transfer_size": 0,
    "fetch_time": "2026-10-02 13:06:13 +00:00",
    "cache_control": {
      "cachable": true,
      "ttl": 0
    },
    "checks": {
      "no_content_encoding": false,
      "high_loading_time": false,
      "from_sitemap": false,
      "is_redirect": false,
      "is_4xx_code": false,
      "is_5xx_code": false,
      "is_broken": false,
      "is_www": true,
      "is_https": true,
      "is_http": false,
      "high_waiting_time": false,
      "has_micromarkup": false,
      "has_micromarkup_errors": false,
      "no_doctype": false,
      "has_html_doctype": true,
      "canonical": true,
      "no_encoding_meta_tag": false,
      "no_h1_tag": false,
      "https_to_http_links": false,
      "size_greater_than_3mb": false,
      "meta_charset_consistency": false,
      "has_meta_refresh_redirect": false,
      "has_render_blocking_resources": true,
      "low_content_rate": true,
      "high_content_rate": false,
      "low_character_count": false,
      "high_character_count": false,
      "small_page_size": false,
      "large_page_size": true,
      "low_readability_rate": false,
      "irrelevant_description": false,
      "irrelevant_title": false,
      "irrelevant_meta_keywords": false,
      "title_too_long": false,
      "has_meta_title": false,
      "title_too_short": false,
      "deprecated_html_tags": false,
      "duplicate_meta_tags": true,
      "duplicate_title_tag": false,
      "no_image_alt": true,
      "no_image_title": true,
      "no_description": false,
      "no_title": false,
      "no_favicon": false,
      "seo_friendly_url": true,
      "flash": false,
      "frame": false,
      "lorem_ipsum": false,
      "seo_friendly_url_characters_check": true,
      "seo_friendly_url_dynamic_check": true,
      "seo_friendly_url_keywords_check": true,
      "seo_friendly_url_relative_length_check": true
    },
    "content_encoding": "br",
    "media_type": "text/html",
    "server": "Vercel",
    "is_resource": false,
    "url_length": 28,
    "relative_url_length": 1,
    "last_modified": null
  },
  "credits_used": 1,
  "request_id": "req_example000000",
  "cached": false,
  "credits_remaining": 9999,
  "source": "captured",
  "captured_at": "2026-10-02T13:06:13.723Z",
  "redacted": true
}

Live sample illustrating the unified response shape. Field values reflect the record you query.

API Details

How does the On-Page Page API work?

Send a GET request with your API key and get back clean, structured JSON in our unified schema. Supported computed fields are populated when the source provides the required inputs.

Method

GET

Response

JSON

Why SocialCrawl

Why use SocialCrawl for On-Page Page data?

We handle the complexity of On-Page data extraction so you can focus on building. Unified schema, AI enrichment, and zero platform logic in your code.

Developer First

How do you scrape social media data in seconds?

The fastest social media scraping API for developers. Scrape profiles, posts, comments, and analytics from 69 platforms covering 10B+ monthly active users.

One schema, every platform

Query 69 platforms with identical response structures. Write your integration once.

Computed fields, not just scraped

When an endpoint supports these metrics and the source provides the required inputs, the normalized record includes engagement_rate, estimated_reach, content_category, and language. Ready to use.

See your data before you code

Visual Data Explorer. Paste any URL, get rich result cards, sortable tables, CSV export.

import requests

response = requests.get(
    'https://www.socialcrawl.dev/v1/tiktok/profile',
    params={'handle': 'charlidamelio'},
    headers={'x-api-key': 'sc_YOUR_API_KEY'}
)
data = response.json()
[ .JSON ]
{
  "success": true,
  "platform": "tiktok",
  "data": {
    "author": {
      "username": "charlidamelio",
      "followers": 152400000
    },
    "engagement": {
      "likes": 12400000000,
      "engagement_rate": 0.087
    },
    "metadata": {
      "language": "en",
      "content_category": "lifestyle"
    }
  }
}
+ 69 platforms
FAQ

Have a question? We got answers

Find answers to frequently asked questions about SocialCrawl's API, pricing, and capabilities.

Contact us
How do I audit a URL with the on-page API?
GET /v1/on_page/page?url=https://example.com with your x-api-key. The response is one Analytics object with score, checks, and meta.
What URL format does the on-page API accept?
An absolute URL including https://. Relative paths and missing schemes are rejected before the upstream call.
Does the on-page API execute JavaScript?
Not by default. Pass enable_javascript=true when the page injects title or canonical in the browser.
How much does GET /v1/on_page/page cost?
1 credit per request. Cache hits on the same URL cost 0 credits.
Can I crawl a whole domain with this endpoint?
No. Each call audits one URL. For site-wide crawls use a dedicated crawler, not this instant page audit.

Ask AI about SocialCrawl

Ready to scrape On-Page Page data?

Get your API key and start pulling On-Page data in under 60 seconds.

Start for free

🤖 AI agent or LLM? Read this page as markdown