Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.crawlstack.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Public API allows you to trigger runs and retrieve data from outside the browser.

Base URL

The Base URL for a specific crawler is formatted as: https://relay.crawlstack.dev/ext/{extension_uuid}/crawler/{crawler_id}

Endpoints

GET /data

Execute the crawler or get cached data.
$max_age_s
number
Max age of cached run in seconds. Defaults to 0 (always run).
start_url
string
Override the start URL for this execution.

GET /items

Get extracted items for the crawler.
cursor
number
Pagination cursor (last item ID).
limit
number
default:"20"
Number of items to return.
all
string
If set to true, returns all versions of items. Otherwise returns only the latest version.

GET /items/{itemKey}/versions

Get history of a specific item.
itemKey
string
required
The unique key of the item.