POST
/
v4
/
adhoc
/
{templateId}

Authorizations

x-api-key
string
header
required

Path Parameters

templateId
string
required

Either a custom template ID or one of the following special values:

  • html - Returns raw HTML of the page
  • body - Returns cleaned HTML body content
  • markdown - Returns content converted to markdown format

Body

application/json

The URL link to be scraped

location
object

The location object for the proxy

Response

200
application/json
Response object containing scraping data and request metadata
status
string

Status of the response

The URL that was scraped

location
object

The location object used for the proxy

data
object

Validated data after scraping and processing

screenshotUrl
string

Path to the screenshot

requestTimeMs
integer

The time taken to process the request in milliseconds