POST
/
scrape

Authorizations

Authorization
string
headerrequired

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

Body

application/json
url
string
required

The URL to scrape

formats
enum<string>[]

Formats to include in the output.

Available options:
markdown,
html,
rawHtml,
links,
screenshot,
extract,
screenshot@fullPage
onlyMainContent
boolean
default: true

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

includeTags
string[]

Tags to include in the output.

excludeTags
string[]

Tags to exclude from the output.

headers
object

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

waitFor
integer
default: 0

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

timeout
integer
default: 30000

Timeout in milliseconds for the request

extract
object

Extract object

actions
object[]

Actions to perform on the page before grabbing the content

Response

200 - application/json
success
boolean
data
object
IntroductionCrawl