Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-132176113.0 KB
webscrape

Scrape a webpage with custom options

post/web-scraping

Request body

urlstring required

Target URL

device'desktop' | 'mobile'

Device type to emulate. Defaults to desktop.

blockAdsboolean

Whether to block ads

renderJSboolean

Whether to render JavaScript

proxyCountrystring

Proxy country code to route the request

format'html' | 'markdown' | 'json' | 'markdown-filtered' | 'all'

Format of the scraped result. Defaults to html.

fileOutputboolean

Whether to get response in file format

extractionMode'default' | 'cssSchema' | 'xpathSchema'

Extraction mode (only used if format=json)

Example request

{
  "url": "https://example.com",
  "device": "desktop",
  "blockAds": true,
  "renderJS": true,
  "proxyCountry": "us",
  "format": "html",
  "extractionMode": "default",
  "extractionSchema": {
    "name": "Product Schema",
    "baseSelector": ".product",
    "fields": [
      {
        "title": "Product Name"
      }
    ]
  }
}

Response

Successfully scraped webpage

timestampnumber required

Timestamp of the request in milliseconds

apiStatus'success' | 'failure' required

API status message

apiCodenumber required

API status code

Example response

{
  "timestamp": 1763372588297,
  "apiStatus": "success",
  "apiCode": 200,
  "meta": {
    "url": "https://example.com",
    "device": "desktop",
    "format": "html",
    "blockAds": true,
    "renderJS": true,
    "extractionMode": "default",
    "extractionSchema": {
      "name": "Product Schema",
      "baseSelector": ".product",
      "fields": [
        {
          "title": "Product Name"
        }
      ]
    },
    "test": {
      "id": "mxqx9v9y0742lap6altwdteqd28t23nq"
    }
  }
}