Crawl

Crawl websites.

browser_rendering.crawl.create() -> CrawlCreateResponse

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

Get crawl result.

browser_rendering.crawl.get(, ) -> CrawlGetResponse

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

Cancel a crawl job.

browser_rendering.crawl.delete(, ) -> CrawlDeleteResponse

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

ModelsExpand Collapse

str

Crawl job ID.

class CrawlGetResponse: …

id: str

Crawl job ID.

browser_seconds_used: float

Total seconds spent in browser so far.

finished: float

Total number of URLs that have been crawled so far.

records: List[Record]

List of crawl job records.

status: Literal["queued", "errored", "completed", 3 more]

Current status of the crawled URL.

One of the following:

"queued"

"errored"

"completed"

"disallowed"

"skipped"

"cancelled"

url: str

Crawled URL.

html: Optional[str]

HTML content of the crawled URL.

json: Optional[Dict[str, Optional[object]]]

JSON of the content of the crawled URL.

markdown: Optional[str]

Markdown of the content of the crawled URL.

metadata: Optional[RecordMetadata]

Absent for urls that never reached a fetch.

status: float

HTTP status code of the crawled page.

url: str

Final URL of the crawled page.

last_modified: Optional[str]

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

og_description: Optional[str]

Open Graph description of the crawled page.

og_image: Optional[str]

Open Graph image of the crawled page.

og_site_name: Optional[str]

Open Graph site name of the crawled page.

og_title: Optional[str]

Open Graph title of the crawled page.

og_type: Optional[str]

Open Graph type of the crawled page.

title: Optional[str]

Title of the crawled page.

outcome: Optional[Literal["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: List[Robot]

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

origin: str

Origin whose robots.txt was checked.

state: Literal["available", "absent", "fetch_failed"]

Whether usable robots.txt rules were available.

One of the following:

"available"

"absent"

"fetch_failed"

status: Optional[float]

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

skipped: float

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: str

Current crawl job status.

total: float

Total current number of URLs in the crawl job.

cursor: Optional[str]

Cursor for pagination.

class CrawlDeleteResponse: …

job_id: str

The ID of the cancelled job.

message: str

Cancellation confirmation message.