Render

Body parameters

Example

A JavaScript-heavy page in a real browser, escalating through the unblocking tiers if the site pushes back:

curl -X POST https://api.104-236-84-15.sslip.io/v1/render \
  -H "Authorization: Bearer $PAGETEER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/pricing","mode":"browser","unblock":"auto","formats":["markdown","metadata"]}'

const res = await fetch('https://api.104-236-84-15.sslip.io/v1/render', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.PAGETEER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://example.com/pricing",
    "mode": "browser",
    "unblock": "auto",
    "formats": [
      "markdown",
      "metadata"
    ]
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.message);
console.log(data, res.headers.get('x-credits-remaining'));

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['PAGETEER_API_KEY']}"}
res = requests.post(
    "https://api.104-236-84-15.sslip.io/v1/render",
    headers=headers,
    json={
        "url": "https://example.com/pricing",
        "mode": "browser",
        "unblock": "auto",
        "formats": ["markdown", "metadata"],
    },
    timeout=120,
)
res.raise_for_status()
print(res.json(), res.headers["x-credits-remaining"])

{
  "url": "https://example.com/pricing",
  "final_url": "https://example.com/pricing",
  "status": 200,
  "title": "Pricing – Example",
  "markdown": "# Pricing\n…",
  "metadata": {
    "title": "Pricing – Example",
    "description": "Plans for every team.",
    "canonical": "https://example.com/pricing",
    "lang": "en",
    "og": { "title": "Pricing – Example", "type": "website" },
    "twitter": {},
    "json_ld": [],
    "favicon": "https://example.com/favicon.ico",
    "robots": null,
    "author": null,
    "published_time": null,
    "keywords": null
  },
  "tier_used": "stealth",
  "mode_used": "browser",
  "attempts": [
    { "tier": "none", "status": 403, "ms": 640, "blocked": true, "block_reason": "status_403" },
    { "tier": "stealth", "status": 200, "ms": 2140 }
  ],
  "cached": false,
  "credits": 10
}

Response fields

Only the formats you asked for are present.

If the site answers with a 5xx, you still get 200 from us with that status, and credits: 0: a failing site is not charged.

Structured data

Many pages already carry their data in machine-readable form: schema.org JSON-LD, microdata or RDFa, OpenGraph tags, or the JSON state a JavaScript app was rendered from. The structured format returns all of it from the one fetch, parsed, with no LLM and no extra credits. It works in HTTP mode, which is the cheapest and least likely to meet a CAPTCHA, so try mode: "http" first: embedded state such as __NEXT_DATA__ is in the HTML before any JavaScript runs.

curl -X POST https://api.104-236-84-15.sslip.io/v1/render \
  -H "Authorization: Bearer $PAGETEER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://realty.example/listing/123-maple","mode":"http","formats":["structured"]}'

const res = await fetch('https://api.104-236-84-15.sslip.io/v1/render', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.PAGETEER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://realty.example/listing/123-maple",
    "mode": "http",
    "formats": [
      "structured"
    ]
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.message);
console.log(data, res.headers.get('x-credits-remaining'));

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['PAGETEER_API_KEY']}"}
res = requests.post(
    "https://api.104-236-84-15.sslip.io/v1/render",
    headers=headers,
    json={
        "url": "https://realty.example/listing/123-maple",
        "mode": "http",
        "formats": ["structured"],
    },
    timeout=120,
)
res.raise_for_status()
print(res.json(), res.headers["x-credits-remaining"])

{
  "structured": {
    "records": [
      {
        "kind": "listing", "type": "RealEstateListing", "source": "json_ld",
        "name": "123 Maple St, Springfield, IL 62704", "url": "https://realty.example/listing/123-maple",
        "price": 425000, "currency": "USD", "availability": "InStock",
        "property_type": "SingleFamilyResidence", "bedrooms": 4, "bathrooms": 2.5,
        "floor_size": { "value": 2150, "unit": "FTK" }, "year_built": 1998,
        "address": { "street": "123 Maple St", "locality": "Springfield", "region": "IL",
                     "postal_code": "62704", "country": "US", "formatted": "123 Maple St, Springfield, IL 62704, US" },
        "geo": { "lat": 39.7817, "lng": -89.6501 }, "date_posted": "2026-09-14", "image": "https://…", "description": null,
        "merged_from": []
      },
      {
        "kind": "business", "type": "RealEstateAgent", "name": "Example Realty",
        "phone": "(217) 555-2671", "phone_e164": "+12175552671", "email": "sales@realty.example",
        "address": { … }, "geo": null, "hours": [], "url": "https://realty.example/", …
      }
    ],
    "json_ld": [ { "@context": "https://schema.org", "@type": "RealEstateListing", … } ],
    "microdata": [],
    "rdfa": [],
    "opengraph": { "og:title": "123 Maple St, Springfield, IL 62704", "og:image": ["https://…", "https://…"] },
    "twitter": { "twitter:card": "summary_large_image" },
    "app_state": [
      { "source": "next_data", "id": "__NEXT_DATA__", "parsed": true, "bytes": 18234, "data": { "props": { … } } }
    ],
    "truncated": false,
    "errors": []
  },
  "credits": 1
}

• json_ld: every application/ld+json block, parsed (trailing commas and HTML-comment wrappers tolerated), with @graph flattened into its nodes. Each node keeps its @context.
• microdata and rdfa: top-level itemscope / typeof items in the same JSON-LD-like shape. schema.org types are shortened (Product, not the full URL). RDFa support is RDFa Lite (vocab, typeof, property).
• opengraph: og:*, product:*, place:*, business:* and article:* tags, keyed by the full property name (repeated tags become arrays). twitter: twitter:* tags.
• app_state: embedded application state. source is next_data (Next.js __NEXT_DATA__), nuxt_data (Nuxt 3, decoded from its devalue format), nuxt (window.__NUXT__), apollo_state (window.__APOLLO_STATE__), window_state (other window.__NAME__ = {…} or JSON.parse("…") assignments) or json_script (any other application/json script). parsed: false means the value is JavaScript rather than JSON (Nuxt 2's function form, for example) and data is null.
• records: one normalized record per listing, business or product found in JSON-LD, microdata or RDFa (de-duplicated across the three). Every record has kind, type, source, name, url, description and image; missing values are null.
  • listing (RealEstateListing, SingleFamilyResidence, House, Apartment and other Residence / Accommodation types, and an Offer whose itemOffered is one): price, currency, availability, property_type, address, geo, bedrooms, bathrooms, floor_size, lot_size, year_built, date_posted, merged_from. A listing that wraps its home in mainEntity, about or itemOffered (inline or by @id) becomes one merged record.
    Some sites (Redfin, for example) publish each home twice: a Residence with the address but no price, and next to it a Product or Offer with the same name and URL that carries the price. When a product describes the same home as a listing (the same @id, the same URL ignoring www., a trailing slash and the fragment, or the same name on the same host) and exactly one listing matches, the two become one listing: its empty price, currency, availability, name, url, description and image are filled from the product, the product record is dropped, and merged_from lists what was folded in ([{kind, type, source, url}], empty otherwise). Products that match no listing stay products.
  • business (Organization, LocalBusiness and its subtypes): address, phone, phone_e164, email, geo, hours ({days, opens, closes} from openingHoursSpecification, or {text} from openingHours), price_range, same_as.
  • product (Product, ProductGroup, Vehicle, …, and a standalone Offer): price, currency, availability (e.g. InStock), condition, low_price, high_price, offer_count, sku, gtin, mpn, brand, rating ({value, count}).
  Prices are numbers ("425,000" becomes 425000); address is {street, locality, region, postal_code, country, formatted} and geo is {lat, lng}. The raw blocks are always there too, for fields the records do not cover.
• Size cap: the whole structured object is capped at about 1 MB. A block that does not fit is shrunk (long strings and arrays are cut) or its data is dropped; that block gets truncated: true and its original size in bytes, and the top-level truncated is true. Records come first, raw app state last. errors lists blocks that could not be parsed (an invalid JSON-LD block does not fail the request).

Caching

Fetching the same page again and again is slow for you and noisy for the site. Send max_age (seconds, up to a day) to opt in:

• If your account made the same request (same URL and options) less than max_age seconds ago, you get that result back without us contacting the site: "cached": true, cache_age_s, the x-cache: HIT header, and 0 credits.
• If the copy is older and the site sent an ETag or Last-Modified, we ask the site whether it changed (a conditional GET, HTTP fetches only). If it did not (304 Not Modified), you get the copy with "revalidated": true and x-cache: REVALIDATED for 1 credit plus the tier add-on. Otherwise we fetch the page normally and store it.
• max_age: 0 always fetches but stores the result for later requests. Without max_age nothing is read from or written to the cache.
• Only successful (2xx) results are stored. Cached pages are scoped to your team and kept in memory and the database. Entries expire within 24 hours of the original fetch; accessing or revalidating a copy does not extend that deadline. Database TTL deletion runs asynchronously and can lag expiry. Entries may drop early under load. The default entry cap is 8 MiB, with a 1 MiB database cap for screenshots and PDFs; oversized entries are skipped in full.
• Identical concurrent cacheable requests within your team share one fetch. Followers are charged as cache hits. Schema extraction still runs and is charged separately for each request.

Polite fetching

Sites escalate to CAPTCHAs and blocks when a client looks abusive. We fetch politely on your behalf, which keeps your success rate up:

• Requests to any one site are spaced out and capped in concurrency, across all customers.
• If the site answers 429, or 503 with Retry-After, we stop: you get 429 target_rate_limited with retry_after (free), and requests to that site pause for everyone until then instead of retrying or escalating tiers.
• Network errors and 502/503/504 are retried a couple of times with exponential backoff and jitter, within your timeout_ms.
• With respect_robots: true we check robots.txt first and honor its Crawl-delay.

Credits

• HTTP mode: 1; browser mode: 5. With mode: "auto" you pay for the mode the engine used. wait_for, wait_ms and the screenshot format need a browser, so they cost the browser price.
• Plus the tier that succeeded: stealth +5, residential through your own proxy +0. Blocked attempts before it are free.
• Formats are free: structured, metadata or all nine cost the same as the render alone.
• Served from the cache (max_age): 0. Revalidated (304): 1 plus the tier add-on.
• The example above (browser + stealth) costs 10 credits. A 404 from the target is a successful render and is charged; a target 5xx and all of our errors are not.

Errors