Web Scrape — API reference

POST

Available

/web/scrape

Web Scrape

Extract a public HTTP or HTTPS page by URL, with supported text, HTML, Markdown and selector options. Source restrictions still apply.

type

web_scrape

result

schemas.source_data

Billing

1 credits

Extract a public HTTP or HTTPS page by URL, with supported text, HTML, Markdown and selector options. Source restrictions still apply.

Parameters

FieldTypeAvailabilityDescription

url

sample

string

Catalog sample; the API validates required fields.

sample: "https://example.com"

country

optional

string

optional

Public alias for locale.country. Use one spelling at a time; the API validates the parameters and values supported by this product.

cursor

optional

string

optional

Public alias for pagination.cursor. Use one spelling at a time; the API validates the parameters and values supported by this product.

custom_headers

optional

object

optional

Public alias for headers. Use one spelling at a time; the API validates the parameters and values supported by this product.

device

optional

string

optional

Public alias for options.device. Use one spelling at a time; the API validates the parameters and values supported by this product.

gl

optional

string

optional

Public alias for locale.country. Use one spelling at a time; the API validates the parameters and values supported by this product.

hl

optional

string

optional

Public alias for locale.language. Use one spelling at a time; the API validates the parameters and values supported by this product.

html

optional

boolean

optional

Public alias for include_html. Use one spelling at a time; the API validates the parameters and values supported by this product.

language

optional

string

optional

Public alias for locale.language. Use one spelling at a time; the API validates the parameters and values supported by this product.

limit

optional

integer

optional

Public alias for pagination.limit. Use one spelling at a time; the API validates the parameters and values supported by this product.

markdown

optional

boolean

optional

Public alias for include_markdown. Use one spelling at a time; the API validates the parameters and values supported by this product.

mobile

optional

boolean

optional

Public alias for options.device. Use one spelling at a time; the API validates the parameters and values supported by this product.

num

optional

integer

optional

Public alias for pagination.limit. Use one spelling at a time; the API validates the parameters and values supported by this product.

page

optional

integer

optional

Public alias for pagination.page. Use one spelling at a time; the API validates the parameters and values supported by this product.

q

optional

string

optional

Public alias for query. Use one spelling at a time; the API validates the parameters and values supported by this product.

json

{
  "url": "https://example.com"
}

Open in Playground

The response follows this product's contract; no recorded response example is published yet.schemas.source_data

Code and response examples

bash

curl -X POST 'https://api.serpbase.dev/web/scrape' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"url":"https://example.com"}'

Notes

Use the catalog sample to get started, then inspect the actual JSON response.

The sample shows example parameters, not the complete request contract. Known fields are validated by the API; additional parameters are allowed.