Web Scrape — Referência da API

POST

Disponível

/web/scrape

Web Scrape

Extraia páginas públicas HTTP/HTTPS por URL com texto, HTML, Markdown e seletores; aplicam-se restrições da origem.

type

web_scrape

result

schemas.source_data

Cobranca

1 credits

Extraia páginas públicas HTTP/HTTPS por URL com texto, HTML, Markdown e seletores; aplicam-se restrições da origem.

Parametros

CampoTipoDisponibilidadeDescricao

url

exemplo

string

Exemplo do catálogo; a API valida campos obrigatórios.

exemplo: "https://example.com"

country

opcional

string

opcional

locale.country: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

cursor

opcional

string

opcional

pagination.cursor: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

custom_headers

opcional

object

opcional

headers: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

device

opcional

string

opcional

options.device: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

gl

opcional

string

opcional

locale.country: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

hl

opcional

string

opcional

locale.language: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

html

opcional

boolean

opcional

include_html: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

language

opcional

string

opcional

locale.language: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

limit

opcional

integer

opcional

pagination.limit: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

markdown

opcional

boolean

opcional

include_markdown: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

mobile

opcional

boolean

opcional

options.device: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

num

opcional

integer

opcional

pagination.limit: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

page

opcional

integer

opcional

pagination.page: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

q

opcional

string

opcional

query: Aliases de parâmetros: use uma forma por vez. A API valida parâmetros e valores aceitos.

json

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

Abrir no Playground

A resposta segue o contrato do produto; ainda não há exemplo registrado publicado.schemas.source_data

Exemplos de código e resposta

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"}'

Notas

Comece com o exemplo do catálogo e confira o JSON real.

O exemplo não é o contrato completo. Campos conhecidos são validados e parâmetros adicionais são permitidos.