Scraper Endpoint

Handles scraping requests with optional rendering, screenshots, and workflow support.

Query Parameters

api_key

string

required

API key for authentication.

Example:

"your-api-key"

url

string

required

The URL to scrape.

Example:

"https://example.com"

render

boolean

Indicates if rendering is required.

Example:

true

window_height

integer

The height of the browser window.

Example:

800

window_width

integer

The width of the browser window.

Example:

1200

screenshot

boolean

If set to true, captures a screenshot of the page.

Example:

false

screenshot_full_page

boolean

If set to true, captures a full-page screenshot.

Example:

false

workflow_id

string

Workflow ID to use pre-configured settings.

Example:

"workflow-12345"

block_resources

string

Comma-separated list of resources to block (e.g., images, css).

Example:

"images,css"

markdown

boolean

If set to true, will return the website in an markdown format.

Example:

"true"

block_ads

boolean

Used for blocking ads from appearing

Example:

"true"

block_cookie_banners

boolean

Used for blocking ads from cookie banners from appearing

Example:

"true"

block_chat_widgets

boolean

Used for blocking chat widgets from appearing

Example:

"true"

webhook_url

string

URL to send the scraping response to via webhook.

Example:

"https://webhook.site/12345"

proxy_type

string

Type of proxy to use for the request.

Example:

"residential"

proxy_country

string

Country code for the proxy location.

Example:

"US"

instructions

string

Array of instructions for browser automation in an encoded json, keep in mind to send it stringified in the url

Example:

"[{\"wait\":\"#element\"},{\"fill\":{\"selector\":\"#input\",\"text\":\"hello\",\"delay\":1000}},{\"click\":\"#submit\"},{\"delay\":2000}]"

Response

200

text/html

Scraping request completed successfully.

The response is of type string.