Tools

The following schemas were verified against the public endpoint with tools/list on 2026-08-05.

scrape

Fetches one public HTTP(S) URL through a currently available route and returns the selected representation.

Input

Field	Required	Type	Details
url	Yes	string	Public HTTP(S) URL to fetch.
output	No	string	markdown (default), text, or html.

Result

On success, the result object includes ok, url, final_url, status_code, content_type, title, output_format, content, bytes_received, redirects, route, request_id, and quota.

Example arguments:

{
  "url": "https://example.com",
  "output": "text"
}

Possible errors

• Invalid URL or unsupported URL scheme.
• Unsupported output format.
• Anonymous quota or concurrency limit reached.
• Upstream fetch failure, timeout, or unavailable route.
• Response exceeds the current response-size limit.

usage

Returns quota state for the requesting source IP address.

Input

No fields.

Result

Returns anonymous, a quota object with hour, day, week, and month usage windows, plus concurrency_limit, response_max_bytes, and upgrade_url.

Example arguments:

{}

Possible errors

The tool normally returns the current state. Transport or service availability failures can prevent a response.

service_status

Returns public availability metadata for the service and proxy inventory.

Input

No fields.

Result

Returns status, live_exits, total_inventory, requests_24h, successful_24h, and timestamp.

Example arguments:

{}

Possible errors

The tool normally returns current status. Transport or service availability failures can prevent a response.