browserflare

Python library for the Cloudflare Browser Rendering APIs.

Prefer a GUI App? Look at our desktop app - browserflare.xyz.

Install

pip install browserflare

Setup

Add your Cloudflare credentials to .env:

CF_ACCOUNT_ID=your_account_id
CF_API_TOKEN=your_api_token

Usage

from browserflare import start_crawl, build_crawl_payload, poll_until_complete, save_results

# Build a crawl payload
payload = build_crawl_payload(
    url="https://browserflare.xyz",
    limit=10,
    formats=["markdown"],
)

# Start the crawl
job_id, err = start_crawl(payload)

# Wait for completion
result, err = poll_until_complete(job_id)

# Save results
save_results(job_id, result, formats=["markdown"])

Screenshots

from browserflare import take_screenshot, build_screenshot_payload, save_screenshot

payload = build_screenshot_payload(url="https://browserflare.xyz", full_page=True)
image_bytes, content_type, err = take_screenshot(payload)
filepath = save_screenshot("https://browserflare.xyz", image_bytes, content_type)

PDFs

from browserflare import generate_pdf, build_pdf_payload, save_pdf

payload = build_pdf_payload(url="https://browserflare.xyz", format="a4")
pdf_bytes, content_type, err = generate_pdf(payload)
filepath = save_pdf("https://browserflare.xyz", pdf_bytes)

Project Structure

src/browserflare/
  __init__.py              # Public re-exports
  exceptions.py            # MissingCredentialsError, etc.
  config.py                # .env loading, API config, constants
  api.py                   # HTTP: start, poll, paginate, cancel crawls
  jobs.py                  # crawl_jobs.json management
  output.py                # Save crawl results, search, stats, diff
  batch.py                 # Batch crawling from URL list
  payloads.py              # Payload builders for crawl, screenshot, PDF
  screenshot_api.py        # POST to /screenshot endpoint
  screenshot_output.py     # Save screenshots + JSON log
  pdf_api.py               # POST to /pdf endpoint
  pdf_output.py            # Save PDFs + JSON log