API reference
Scrape
Turn any URL into Markdown, HTML, structured JSON, or a screenshot.
POSThttps://api.scrapeflow.dev/v1/web/scrape1 credit (+1 per extra format)
Fetches a page with JavaScript rendering and managed proxies, then returns the formats you ask for. Use `formats` to request one or many outputs in a single call.
Request
curl -X POST ${SCRAPEFLOW_API_URL}/v1/web/scrape \
-H "Authorization: Bearer $SCRAPEFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://linear.app", "formats": { "markdown": true } }'Parameters
| Parameter | Type | Description |
|---|---|---|
| urlrequired | string | The absolute URL to scrape. |
| formats | object | Any of markdown, html, rawHtml, links, screenshot, json (all boolean). Defaults to { markdown: true }. |
| onlyMainContent | boolean | Strip nav, footers, and boilerplate. Default true. |
| waitFor | number | Milliseconds to wait after load for dynamic content. |
| jsonSchema | object | JSON schema for structured extraction when formats.json is true. |
Response
json
{
"success": true,
"credits_used": 1,
"data": {
"url": "https://linear.app",
"markdown": "# Linear\nThe issue tracking tool built for...",
"metadata": { "title": "Linear", "statusCode": 200, "language": "en" }
}
}