Skip to content

Scrape parameters

Body fields

FieldTypeRequiredNotes
urlstringyesTarget URL to fetch.
formatstringnoTypical values: markdown, html, text.
only_main_contentbooleannoUses Readability-style cleanup for article pages.
premiumbooleannoOpt into premium routing for harder targets.
proxy_countrystringnoTwo-letter ISO country code for proxy routing.
querystringnoAsk for a specific extraction focus from the page.
render_jsbooleannoForce a JS-rendered fetch path.
screenshotbooleannoAttach a rendered screenshot URL in the response.
pdf_modefast | auto | ocrnoControl the PDF extraction path.
max_pagesnumbernoMaximum pages to parse in a PDF.

Practical guidance

  • start with format: "markdown" for LLM pipelines
  • add only_main_content: true for articles, docs pages, and blogs
  • add render_js: true only when static fetch misses meaningful content
  • use query when you want the extractor to bias toward a specific answer
  • use pdf_mode: "ocr" only for scanned documents

JS-heavy scrape with screenshot output

```bash curl https://api.faircompany.ai/v1/crawl/web/scrape \ -X POST \ -H "Authorization: Bearer fc_live_xxx" \ -H "Content-Type: application/json" \ -d '{ "url": "https://app.linear.app/changelog", "render_js": true, "screenshot": true }' ```