POST
/
scrape

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

The URL to scrape

actions
object[]

Actions to perform on the page before grabbing the content

excludeTags
string[]

Tags to exclude from the output.

formats
enum<string>[]

Formats to include in the output.

Available options:
markdown,
html,
rawHtml,
links,
screenshot,
screenshot@fullPage,
json
headers
object

Headers to send with the request. Can be used to send cookies, user-agent, etc.

includeTags
string[]

Tags to include in the output.

jsonOptions
object

Extract object

location
object

Location settings for the request. When specified, this will use an appropriate proxy if available and emulate the corresponding language and timezone settings. Defaults to 'US' if not specified.

mobile
boolean
default:
false

Set to true if you want to emulate scraping from a mobile device. Useful for testing responsive pages and taking mobile screenshots.

onlyMainContent
boolean
default:
true

Only return the main content of the page excluding headers, navs, footers, etc.

removeBase64Images
boolean

Removes all base 64 images from the output, which may be overwhelmingly long. The image's alt text remains in the output, but the URL is replaced with a placeholder.

skipTlsVerification
boolean
default:
false

Skip TLS certificate verification when making requests

timeout
integer
default:
30000

Timeout in milliseconds for the request

waitFor
integer
default:
0

Specify a delay in milliseconds before fetching the content, allowing the page sufficient time to load.

Response

200 - application/json
data
object
success
boolean