WebScrapingAPI Docs

Current API Reference

Production reference for WebScrapingAPI, Browser API, SearchData, SERP, and async endpoints.

This section is the production reference for the currently supported public APIs. Use it when you need exact endpoint URLs, accepted parameters, response behavior, async flows, and retry guidance.

Endpoints

APIBase URLBest for
Web Scraping APIhttps://api.webscrapingapi.com/v2Fast HTTP scraping, optional JavaScript rendering, extraction rules, JSON responses, and async jobs.
Browser APIhttps://api.webscrapingapi.com/v1Browser rendering, waits, screenshots, JavaScript instructions, redirect-chain workflows, custom headers, and cookies.
SearchData commerce APIhttps://ecom.webscrapingapi.com/v1Retail and marketplace product, search, review, and batch scrapers.
SERP APIhttps://serpapi.webscrapingapi.com/v2Google, Bing, DuckDuckGo, Yandex, Google Maps, Google Trends, and related SERP engines.

Authentication

Pass api_key on every request. GET requests use the query string. POST requests can use the query string and, where supported, a JSON request body for target or batch input.

curl "https://api.webscrapingapi.com/v2?api_key=YOUR_API_KEY&url=https%3A%2F%2Fexample.com"

Do not expose API keys in browser-side code, mobile apps, public repositories, logs, screenshots, or shared notebooks. Store them as server-side secrets.

Response model

HTML scraping endpoints return the scraped body directly unless you enable a JSON-producing feature. JSON-producing features include json_response=1, json_dom=1, extract_rules, screenshot responses, async submission responses, and structured SearchData or SERP engines.

Most successful SearchData and SERP responses include:

{
  "search_metadata": {
    "status": "Success",
    "status_code": 200
  },
  "server_metadata": {
    "api_config": {
      "api_type": "serp"
    }
  }
}

Production checklist

  • Choose /v2 for standard web scraping and /v1 when you need browser-only behavior.
  • Add request timeouts and retries for transient 429, 500, 502, and 503 responses.
  • Use async jobs for long-running pages, SERP requests, or async commerce workloads.
  • Log response status, request parameters, and WebScrapingAPI response headers, but never log API keys.
  • Persist completed async results in your own storage instead of repeatedly polling old job ids.

On this page