Skip to main content
POST
Scrape a page

Authorizations

X-Web-Extract-Api-Key
string
header
required

API key. X-Api-Key and Bearer authentication are also accepted.

Body

application/json
url
string<uri>
required
formats
enum<string>[]
Available options:
markdown,
html,
rawHtml,
links,
screenshot
location
object
timeout_seconds
integer
default:30
Required range: x >= 1
wait_for_ms
integer
default:0
Required range: x >= 0
use_browser
enum<string>
default:auto
Available options:
never,
auto,
always

Response

Scraped page.

request_id
string
required
url
string<uri>
required
final_url
string<uri>
required
markdown
string
required
metadata
object
required
html
string
rawHtml
string
screenshot
string

PNG data URL when requested.