Async-first web scraping and content extraction library for Python 3.11+ — with intelligent browser fallback, built-in caching, and structured Markdown output.
PageFetch is a modern, asynchronous Python library for fetching web pages and
extracting clean, structured content. It attempts a pooled HTTP request first,
scores the returned HTML using multiple completeness signals, and lazily falls
back to a Camoufox stealth browser when the page looks blocked, empty, or
dependent on client-side JavaScript rendering. The result is always a consistent
FetchResult object carrying Markdown, raw HTML, extracted links, images,
metadata, and more — regardless of which method succeeded.
Perfect for web scraping, content aggregation, LLM data pipelines, SEO analysis, archiving, and any workflow that needs reliable page content without fighting bot detection.
- Quick Start
- Why PageFetch
- Stealth & Anti-Detection
- How It Works
- Installation
- API Reference
- Output Model
- CLI Usage
- Caching
- Proxy Support
- Non-HTML Content
- Configuration Reference
- Development
- License
import asyncio
from pagefetch import PageFetch
async def main() -> None:
async with PageFetch(mode="auto", cache_ttl="24h") as client:
result = await client.fetch("https://example.com")
if result.success:
print(f"Title: {result.title}")
print(f"Markdown length: {len(result.markdown or '')} chars")
print(f"Links found: {len(result.links or [])}")
print(f"Images found: {len(result.images or [])}")
else:
print(f"Failed: {result.error.message}")
asyncio.run(main())async with PageFetch(mode="auto") as client:
results = await client.fetch_many([
"https://example.com",
"https://example.org",
"https://httpbin.org/html",
])
for r in results:
status = "✓" if r.success else "✗"
print(f"{status} {r.url} ({r.fetch_method}, {r.duration_ms:.0f}ms)")| Challenge | PageFetch Solution |
|---|---|
| Bot detection & blocking | Camoufox stealth browser with automatic fallback when HTTP returns empty, blocked (403/429), or JavaScript-dependent pages |
| Over-fetching with heavy browsers | HTTP-first strategy — only ~5–15% of pages need the browser in auto mode |
| Inconsistent output formats | Single FetchResult model: always get .markdown, .html, .text, .links, .images, .metadata |
| Managing concurrency | Built-in semaphores for HTTP (default 10) and browser (default 4) — safe for hundreds of URLs |
| Repeated requests waste bandwidth | SQLite disk cache with configurable TTL, shared across runs |
| Proxy rotation complexity | Native Decodo and DataImpulse integration — configure via env vars |
| Content that isn't HTML | PDFs auto-detected and extracted; XML documents parsed; plain text preserved |
| Dependency management friction | Core HTTP support stays lightweight; browser and PDF features use explicit extras |
| Hard-to-match fingerprints | stealth_level presets + humanize, block_level, request_pacing, session_rotation, and proxy_geo for locale-aligned Accept-Language |
When mode is "auto" or "browser", PageFetch exposes a layered stealth
posture so the browser fingerprint can stay aligned with the proxy exit
country:
| Knob | Purpose |
|---|---|
stealth_level |
One-shot preset: "off" (default), "balanced", or "max". Sets humanize, block_level, request_pacing, and session_rotation together; explicit values still win. |
humanize |
Add small randomized delays to mimic human interaction. |
block_level |
"minimal", "balanced", or "aggressive" resource blocking (third-party trackers, fonts, media). |
session_rotation |
"sticky" reuses one proxy session per domain; "rotate" forces a fresh session per request. |
request_pacing |
Fixed seconds of delay between browser requests (0.0 = none). |
accept_language |
Value sent as the Accept-Language header. |
proxy_geo |
ISO 3166-1 alpha-2 country code (e.g. "US", "DE", "TR"); aligns locale, timezone, and Accept-Language with the exit country. |
# Quiet, fast default for open sites
async with PageFetch(mode="auto") as client:
...
# Maximum stealth for heavily protected targets
async with PageFetch(
mode="browser",
proxy="decodo",
stealth_level="max",
proxy_geo="DE",
) as client:
result = await client.fetch("https://example.com")The CLI exposes every knob via --stealth-level, --block-level,
--humanize / --no-humanize, --session-rotation, --request-pacing,
--accept-language, and --proxy-geo.
- Normalize the URL (scheme, encoding, fragments).
- Check cache — if a valid SQLite entry exists, return instantly.
- HTTP fetch using
httpxwith HTTP/2, connection pooling, and configurable retries.
Non-HTML responses (PDF, XML, plain text) are handled directly without browser overhead. - Content analysis — the
confidencescore evaluates HTML completeness using
text density, structural markup, heading presence, link counts, and common blocking signals
(captcha walls, empty bodies, access-denied patterns). - Browser fallback (auto mode only) — Camoufox takes over only when HTTP content
confidence is below the threshold (default 0.80), or when the server returns a blocked
status (403/429). Timeouts, connection failures, 404s, and 5xx responses fail fast at
the HTTP layer instead of waiting on a browser navigation. - Processing pipeline — cleaned HTML → extracted links, images, metadata →
converted to Markdown via a custom converter that preserves tables, code blocks,
and nested lists. - Cache & return — the structured
FetchResultis persisted to SQLite and returned.
- Python ≥ 3.11
# Core HTTP/HTML support
pip install .
# Add browser fallback
pip install ".[browser]"
python -m camoufox fetch
# Add PDF extraction
pip install ".[pdf]"
# Or install every optional feature
pip install ".[all]"PageFetch never runs pip or downloads browser binaries implicitly. HTTP mode
therefore works without Camoufox, while auto and browser users can provision
the browser feature explicitly.
The main entry point. Use as an async context manager for automatic cleanup.
from pagefetch import PageFetch
client = PageFetch(
mode="auto", # "auto" | "http" | "browser"
proxy="none", # "none" | "decodo" | "dataimpulse"
http_concurrency=10, # Max parallel HTTP requests
browser_concurrency=4, # Max parallel browser instances
cache_enabled=True, # Enable SQLite disk cache
cache_ttl="24h", # TTL: "30m", "2h", "7d", or seconds as int
cache_path=None, # Custom SQLite cache path (None = platform default)
http_timeout=20.0, # Per-request HTTP timeout (seconds)
browser_timeout=45.0, # Per-page browser timeout (seconds)
retries_http=3, # Retry on 429/5xx for HTTP
retries_browser=2, # Retry on browser failure
max_redirects=10, # Maximum redirect chain
max_content_size=25 * 1024 * 1024, # Max response body bytes (25 MiB)
confidence_threshold=0.80, # Min confidence before browser fallback
block_images=True, # Block image loading in browser mode to save bandwidth
block_level="aggressive", # "minimal" | "balanced" | "aggressive" (ignored when stealth_level != "off")
accept_language="en-US,en;q=0.5", # Accept-Language header
humanize=False, # Add small randomized delays to mimic a human
session_rotation="sticky",# "sticky" | "rotate" proxy session strategy
request_pacing=0.0, # Seconds of delay between requests
stealth_level="off", # "off" | "balanced" | "max" preset (sets humanize, block_level, pacing, session_rotation)
proxy_geo=None, # ISO 3166-1 alpha-2 (e.g. "US", "DE") to align locale + Accept-Language
raise_on_error=False, # Raise PageFetchError instead of returning error result
)| Mode | Behavior |
|---|---|
"auto" |
HTTP first; falls back to Camoufox if confidence < threshold (default) |
"http" |
Pure HTTP/2 fetching — no browser, no confidence scoring |
"browser" |
Camoufox stealth browser for every request |
fetch(url, *, mode=None, proxy=None, use_cache=True, cache_ttl=None, raise_on_error=None) → FetchResult
Fetch a single URL. All keyword arguments override the client-level defaults
for this individual request only. For structural / RAW HTML / screenshot
capture use extract() instead — it always runs in browser mode and
returns the rendered page shell.
fetch_many(urls, *, mode=None, proxy=None, use_cache=True, cache_ttl=None, raise_on_error=None) → list[FetchResult]
Fetch multiple URLs concurrently. Deduplicates identical inputs internally, preserves the original input order, and isolates individual failures — one bad URL never affects the others.
extract(url, *, structure=True, compact_structure=False, screenshot="none", screenshot_format="png", proxy=None, use_cache=True, cache_ttl=None, raise_on_error=None) → FetchResult
Fetch a page and return the rendered DOM plus, on demand, a structural
summary and/or a screenshot. extract() always uses mode="browser" —
there is no HTTP→browser pipeline because the goal is the full page shell,
not the article-shaped extraction. Returns a FetchResult populated with:
result.html— the browser-rendered HTML.result.structure—PageStructuresummary (whenstructure=True).result.screenshot/result.screenshot_format— captured screenshot bytes (whenscreenshot != "none");screenshot="viewport"captures the visible area,screenshot="full"captures the entire scrollable page, encoded asscreenshot_format(pngorjpeg).
Screenshots are bounded by PageFetchConfig.screenshot_max_bytes (default
50 MiB) — oversized captures are discarded with a warning. Screenshots are
not persisted in the SQLite cache; when a cached result is returned
and a screenshot was requested, result.warnings carries a hint to
re-fetch with use_cache=False.
Everything PageFetch ships in its top-level pagefetch namespace:
| Symbol | Purpose |
|---|---|
PageFetch, PageFetchConfig |
Client + validated configuration |
FetchResult, LinkInfo, ImageInfo, FetchErrorInfo |
Result dataclasses |
PageStructure, StructureNode, StylesheetInfo, InlineStylesheet, ScriptInfo, InlineScript |
Page-structure summary types |
StructureLimits, extract_structure |
Lower-level structure extraction |
PageFetchError, RuntimeBootstrapError |
Exception hierarchy |
ensure_runtime_requirements, auto_bootstrap_browser |
Pre-flight / force-install Camoufox |
VALID_MODES, VALID_PROXIES |
Allowed-value constants |
Browser dependencies are auto-installed on first browser use. Call
ensure_runtime_requirements() for an up-front check without installing,
or auto_bootstrap_browser() to force installation at any point.
Every fetch returns a FetchResult dataclass:
from dataclasses import dataclass
@dataclass
class FetchResult:
url: str # Normalized request URL
final_url: str | None # URL after all redirects
status_code: int | None # HTTP status code
success: bool # Did the fetch succeed?
content_type: str | None # e.g. "text/html", "application/pdf"
encoding: str | None # Detected charset
title: str | None # Page <title> or PDF title
markdown: str | None # Cleaned Markdown body
html: str | None # Raw HTML (excluded from JSON by default)
text: str | None # Plain-text body fallback
metadata: dict # OpenGraph, Twitter Cards, meta tags
links: list[LinkInfo] # All <a> tags with text, URL, rel
images: list[ImageInfo] # All <img> tags with url, alt, title
structure: PageStructure | None # Bounded DOM/stylesheet/script summary (only when requested)
screenshot: bytes | None # PNG/JPEG screenshot bytes (only when requested)
screenshot_format: str | None # "png" or "jpeg"
fetch_method: str | None # "http" or "browser"
proxy_provider: str # "none", "decodo", or "dataimpulse"
content_confidence: float | None # 0–1 completeness score (None for browser mode)
from_cache: bool # Was this served from cache?
duration_ms: float | None # Total fetch duration
fetched_at: datetime | None # ISO 8601 timestamp
warnings: list[str] # Non-fatal issues (cache skip, etc.)
error: FetchErrorInfo | None # Error details when success=False# JSON output (HTML, structure, and screenshot excluded by default for compactness)
print(result.json(indent=2))
print(result.json(include_html=True)) # Include raw HTML
print(result.json(include_structure=True)) # Include PageStructure summary
print(result.json(include_screenshot=True)) # Include base64-encoded screenshot
# Python dict
data = result.to_dict()
data = result.to_dict(include_html=True)
data = result.to_dict(include_structure=True)
data = result.to_dict(include_screenshot=True)
# Reconstruct from cached JSON
reconstructed = FetchResult.from_dict(data)When you want the full rendered page shell — RAW HTML plus the optional
structural summary and/or screenshot — call extract() instead of
fetch(). extract() always uses browser mode (no auto fallback) and
returns a FetchResult with the rendered DOM:
async with PageFetch() as client:
# RAW HTML + structural summary (no screenshot)
result = await client.extract("https://example.com")
print(result.html)
print(result.structure.root.selector)
# Capture a full-page PNG screenshot too
captured = await client.extract(
"https://example.com",
screenshot="full",
screenshot_format="png",
)
with open("page.png", "wb") as fh:
fh.write(captured.screenshot)extract() runs the same readiness / scroll pipeline as a browser-mode
fetch(), so the captured HTML matches what a visitor sees. Screenshots
follow Playwright's page.screenshot() semantics — screenshot="viewport"
captures the initial visible area, screenshot="full" captures the
entire scrollable page. Use --screenshot-format=jpeg (or
screenshot_format="jpeg" in Python) to compress full-page captures.
The structural summary is identical to the one fetch(extract_structure=True)
used to return:
- A nested DOM tree with filtered attributes, short direct-text previews, a
compact selector, a deterministic CSS path, and a verified
unique_selectorsuitable for starting scraper rules. It remains bounded bymax_depthandmax_nodesso the payload stays predictable even on enormous pages. - External stylesheet URLs (
<link rel="stylesheet">) withmedia,integrity, andcrossoriginhints. - Inline
<style>blocks with a per-block preview and atruncatedflag. - External script URLs (
<script src="…">) withtype,async,defer,integrity, andcrossorigin. - Inline
<script>blocks with a per-block preview,type, and atruncatedflag.
Use the lower-level helper directly when you already have parsed HTML:
from pagefetch import StructureLimits, extract_structure
structure = extract_structure(html, base_url="https://example.com/")StructureLimits exposes max_depth, max_nodes, text_preview, and
inline_source_limit for callers that need different safety bounds.
PageFetch ships with a command-line interface accessible via pagefetch:
# Fetch and print Markdown
pagefetch https://example.com --format markdown
# Fetch and print raw HTML
pagefetch https://example.com --format html
# Fetch from a list and output JSON
pagefetch urls.txt --format json --mode auto
# Save output to a file
pagefetch https://example.com --mode browser -o output.md
# Structured JSON with raw HTML included
pagefetch https://example.com --format json --include-html
# Inspect the page structure as Markdown
pagefetch https://example.com --format structure
# Raw page shell: HTML + structure + (optionally) screenshot, single JSON doc
pagefetch https://example.com --format raw --screenshot full --screenshot-format png
# Include a PageStructure summary inside the regular JSON output
pagefetch https://example.com --format json --include-html
# Multiple URLs from a file (one URL per line)
pagefetch urls.txt --format json --mode auto
# Load configuration from a YAML file with CLI overrides
pagefetch --config config.yaml --mode browser https://example.com
# Override cache TTL and disable image loading
pagefetch https://example.com --cache-ttl 1h --no-block-images
# Use the Decodo proxy with a German exit and locale alignment
pagefetch https://example.com --proxy decodo --proxy-geo DE
# Apply a balanced stealth preset with a rotated proxy session
pagefetch https://example.com --mode browser --stealth-level balanced --session-rotation rotate
# Verbose logging for debugging
pagefetch https://example.com --debugCLI arguments map directly to the Python API:
| Flag | Maps to |
|---|---|
--mode {auto,http,browser} |
mode |
--proxy {none,decodo,dataimpulse} |
proxy |
--http-concurrency N / --browser-concurrency N |
http_concurrency / browser_concurrency |
--timeout SECONDS / --browser-timeout SECONDS |
http_timeout / browser_timeout |
--cache-ttl DURATION / --no-cache |
cache_ttl / cache_enabled=False |
--block-images / --no-block-images |
block_images |
--block-level {minimal,balanced,aggressive} |
block_level |
--accept-language HEADER |
accept_language |
--humanize / --no-humanize |
humanize |
--session-rotation {sticky,rotate} |
session_rotation |
--request-pacing SECONDS |
request_pacing |
--stealth-level {off,balanced,max} |
stealth_level |
--proxy-geo CC |
proxy_geo |
--include-html |
FetchResult.json(include_html=…) |
--screenshot {none,viewport,full} |
PageFetch.extract(screenshot=…) |
--screenshot-format {png,jpeg} |
PageFetch.extract(screenshot_format=…) |
--format {markdown,json,html,structure,raw} |
output renderer |
-o PATH / --output PATH |
write rendered output to a file |
-c PATH / --config PATH |
PageFetchConfig.from_yaml |
--debug |
enable DEBUG logging on the pagefetch logger |
The --screenshot flag (and --format raw) auto-promote the request to
browser mode and route through PageFetch.extract().
Exit codes: 0 all succeeded, 1 all failed, 2 usage/IO error,
3 partial failure.
Running python -m pagefetch with no arguments opens a guided
interactive menu (mode, proxy, stealth, format, URL/file input, …) — useful
when you don't want to memorise the flags. Pass python -m pagefetch --cli
(or invoke the pagefetch console script) to use the argparse CLI
documented above.
PageFetch uses a SQLite-backed disk cache (platformdirs user cache directory
by default). Cache entries are keyed by normalized URL + mode + proxy + relevant
fetch settings, so switching from "auto" to "browser" mode produces a
different cache key.
- Default TTL: 24 hours (configurable:
"30m","2h","7d", or integer seconds) - Automatic: cache hits skip all network and browser work
- Graceful degradation: cache read/write failures never crash a fetch — they produce warnings
# Disable caching for a single request
result = await client.fetch("https://example.com", use_cache=False)
# Override TTL per-request
result = await client.fetch("https://example.com", cache_ttl="1h")
# Use a custom cache location
client = PageFetch(cache_path="/path/to/custom_cache.sqlite3")PageFetch natively supports rotating residential proxy providers:
| Provider | Env Var (Full URL) | Env Vars (Components) |
|---|---|---|
| Decodo | DECODO_PROXY_URL |
DECODO_HOST, DECODO_PORT, DECODO_USERNAME, DECODO_PASSWORD |
| DataImpulse | DATAIMPULSE_PROXY_URL |
DATAIMPULSE_HOST, DATAIMPULSE_PORT, DATAIMPULSE_USERNAME, DATAIMPULSE_PASSWORD |
# Use a proxy provider
async with PageFetch(proxy="decodo") as client:
result = await client.fetch("https://example.com")
# Align locale + Accept-Language with the proxy exit country
async with PageFetch(proxy="decodo", proxy_geo="DE") as client:
result = await client.fetch("https://example.de")
# Force a fresh proxy session per request
async with PageFetch(proxy="dataimpulse", session_rotation="rotate") as client:
results = await client.fetch_many([...])Credentials are never included in results, logs, or cache keys. Configure
either a full proxy URL or the individual components — PageFetch validates
both forms automatically. proxy_geo requires one of the countries defined in
PageFetch's GEO_MAP (case-insensitive ISO 3166-1 alpha-2).
PageFetch handles content types beyond HTML natively:
| Content Type | Detection | Extraction |
|---|---|---|
Magic bytes + Content-Type |
Text via optional pagefetch[pdf] support |
|
| XML | Content-Type matching +xml or application/xml |
Strictly parsed with lxml; visible text surfaces as .text and the original tree is preserved as .markdown inside a fenced XML block |
| Plain text | Fallback when no structured type matches | Served as .text and .markdown directly |
No browser overhead is incurred for non-HTML content — detection happens at the HTTP response level before any processing pipeline runs.
| Parameter | Type | Default | Description |
|---|---|---|---|
mode |
str |
"auto" |
Fetch strategy: "auto", "http", or "browser" |
proxy |
str |
"none" |
Proxy provider: "none", "decodo", or "dataimpulse" |
http_concurrency |
int |
10 |
Maximum concurrent HTTP connections |
browser_concurrency |
int |
4 |
Maximum concurrent browser instances |
cache_enabled |
bool |
True |
Enable SQLite disk cache |
cache_ttl |
str | int |
"24h" |
Cache time-to-live |
cache_path |
str | Path |
platform default | Custom SQLite cache file path |
http_timeout |
float |
20.0 |
HTTP request timeout in seconds |
browser_timeout |
float |
45.0 |
Browser page load timeout in seconds |
retries_http |
int |
3 |
Automatic retries on retryable HTTP errors |
retries_browser |
int |
2 |
Automatic retries on browser failures |
max_redirects |
int |
10 |
Maximum redirect chain to follow |
max_content_size |
int |
25 MiB |
Maximum response body in bytes |
confidence_threshold |
float |
0.80 |
Threshold for browser fallback in auto mode |
block_images |
bool |
True |
Block image loading in browser mode to save bandwidth |
block_level |
str |
"aggressive" |
Resource blocking: "minimal", "balanced", or "aggressive" (overridden by stealth_level) |
accept_language |
str |
"en-US,en;q=0.5" |
Value sent in the Accept-Language header |
humanize |
bool |
False |
Add small randomized delays to mimic a human (overridden by stealth_level) |
session_rotation |
str |
"sticky" |
"sticky" reuses a proxy session per domain; "rotate" forces a new session per request (overridden by stealth_level) |
request_pacing |
float |
0.0 |
Fixed seconds of delay between browser requests (overridden by stealth_level) |
stealth_level |
str |
"off" |
Anti-detection preset: "off", "balanced", or "max" |
proxy_geo |
str | None |
None |
ISO 3166-1 alpha-2 (e.g. "US", "DE") to align locale/timezone/Accept-Language with proxy exit country |
raise_on_error |
bool |
False |
Raise PageFetchError on failure instead of returning error result |
screenshot_max_bytes |
int |
50 MiB |
Maximum bytes for an extract(screenshot=…) capture; oversized screenshots are discarded with a warning |
# Clone and set up
git clone <repo-url> && cd pagefetch
# Install with test dependencies
pip install -e ".[test]"
# Run the test suite (browser integration tests are opt-in)
pytest
# Lint
ruff check .Browser integration requires the separately downloaded Camoufox binary and is therefore kept optional in deterministic test environments. The test suite is designed to run fully offline — URLs are served via local fixtures.
PageFetch is released under the MIT License.
Built with ❤️ for developers who need reliable, structured web content without fighting bot detection.