API reference

Search

Search the web and get ranked results with titles and snippets.

POSThttps://api.scrapeflow.dev/v1/web/search2 credits

Runs a web search and returns structured results. Optionally scrape each result in the same call by passing `scrapeResults: true`.

Request

curl -X POST ${SCRAPEFLOW_API_URL}/v1/web/search \
  -H "Authorization: Bearer $SCRAPEFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "query": "best issue tracker for startups", "limit": 5 }'

Parameters

ParameterTypeDescription
queryrequiredstringThe search query.
limitnumberMax results to return (1–50). Default 10.
scrapeResultsbooleanAlso scrape each result to Markdown. Adds 1 credit per result.

Response

json
{
  "success": true,
  "credits_used": 2,
  "results": [
    { "title": "Linear", "url": "https://linear.app", "snippet": "The issue tracking tool..." },
    { "title": "Linear Docs", "url": "https://linear.app/docs", "snippet": "Get started with..." }
  ]
}