Skip to main content
POST
Start a crawl

Authorizations

X-API-Key
string
header
required

Body

application/json
url
string
required

The site to start from. Must be http(s).

Example:

"https://example.com"

limit
number

Maximum number of pages to scrape.

Required range: 1 <= x <= 5000
Example:

100

maxDepth
number

How many links deep from the starting page to follow.

Required range: 0 <= x <= 10
Example:

2

includePaths
string[]

Only follow URLs whose path matches every one of these patterns.

Maximum array length: 50
Example:
excludePaths
string[]

Skip URLs whose path matches any of these patterns.

Maximum array length: 50
Example:
allowSubdomains
boolean

Also follow links into subdomains of the starting site. Default off.

Example:

false

Also follow links that lead off the starting site. Default off.

Example:

false

ignoreQueryParameters
boolean

Treat URLs that differ only by query string as the same page. Default off.

Example:

false

sitemap
enum<string>

Whether to seed discovery from the site's published page list. Default includes it.

Available options:
skip,
include
Example:

"include"

webhook
object

Register a callback to be notified as the crawl progresses instead of polling.

scrapeOptions
object

How to scrape each page. Same options as a single scrape.

Response

201 - application/json

The crawl was accepted.

crawlId
string
required

Poll this crawl id for progress and results.

Example:

"019f3c09-6fae-740f-9257-10c2b6af7f43"

status
enum<string>
required

The job has been accepted.

Available options:
queued
Example:

"queued"