Skip to main content

Get your API key

Copy your API key from the dashboard. Send it in the Authorization header - replace TOKEN VALUE in the examples below with your key.

Start a crawl

Send a POST request with the URL you want to crawl. The response returns a crawl_id.
The response contains the crawl_id, the crawl’s status and links to its status and results.
Response example

Check the crawl status

Use the crawl_status link from the response to see how far the crawl has progressed.
When status is done, every page has been processed.
Response example
See Status, Results & Cancellation for what each field means.

Get the results

Use results_content to get the scraped page content inline in the response, or results_tasks for a list of every crawled URL and its status.
Results are stored for 24 hours after the crawl finishes. Fetch them within that window.