Crawl

Crawl websites.

client.browserRendering.crawl.create(, ?): CrawlCreateResponse

POST/accounts/{account_id}/browser-rendering/crawl

Get crawl result.

client.browserRendering.crawl.get(, , ?): CrawlGetResponse { id, browserSecondsUsed, finished, 6 more }

GET/accounts/{account_id}/browser-rendering/crawl/{job_id}

Cancel a crawl job.

client.browserRendering.crawl.delete(, , ?): CrawlDeleteResponse { job_id, message }

DELETE/accounts/{account_id}/browser-rendering/crawl/{job_id}

ModelsExpand Collapse

CrawlCreateResponse = string

Crawl job ID.

CrawlGetResponse { id, browserSecondsUsed, finished, 6 more }

id: string

Crawl job ID.

browserSecondsUsed: number

Total seconds spent in browser so far.

finished: number

Total number of URLs that have been crawled so far.

records: Array<Record>

List of crawl job records.

status: "queued" | "errored" | "completed" | 3 more

Current status of the crawled URL.

One of the following:

"queued"

"errored"

"completed"

"disallowed"

"skipped"

"cancelled"

url: string

Crawled URL.

html?: string

HTML content of the crawled URL.

json?: Record<string, unknown>

JSON of the content of the crawled URL.

markdown?: string

Markdown of the content of the crawled URL.

metadata?: Metadata { status, url, lastModified, 6 more }

Absent for urls that never reached a fetch.

status: number

HTTP status code of the crawled page.

url: string

Final URL of the crawled page.

lastModified?: string

Value of the Last-Modified response header, when provided by the origin.

"og:description"?: string

Open Graph description of the crawled page.

"og:image"?: string

Open Graph image of the crawled page.

"og:site_name"?: string

Open Graph site name of the crawled page.

"og:title"?: string

Open Graph title of the crawled page.

"og:type"?: string

Open Graph type of the crawled page.

title?: string

Title of the crawled page.

outcome?: "success" | "robots_disallowed" | "crawl_purpose_disallowed" | 9 more

Result of processing the URL. Absent for older records.

One of the following:

"success"

"robots_disallowed"

"crawl_purpose_disallowed"

"content_use_disallowed"

"connection_error"

"timeout"

"browser_unavailable"

"format_generation_error"

"unsupported_content_type"

"unclassified_error"

"page_error"

"too_large"

robots: Array<Robot>

Robots.txt state for the first 50 origins encountered by the crawl.

origin: string

Origin whose robots.txt was checked.

state: "available" | "absent" | "fetch_failed"

Whether usable robots.txt rules were available.

One of the following:

"available"

"absent"

"fetch_failed"

status?: number

HTTP status that established the current robots.txt state. Absent when no HTTP response was received.

skipped: number

Total number of URLs that were skipped due to include/exclude/subdomain filters. Skipped URLs are included in records but are not counted toward total/finished.

status: string

Current crawl job status.

total: number

Total current number of URLs in the crawl job.

cursor?: string

Cursor for pagination.

CrawlDeleteResponse { job_id, message }

job_id: string

The ID of the cancelled job.

message: string

Cancellation confirmation message.