Browser Actions

Scraper APIs support performing a number of browser actions before retrieving a desired result.

Fetching a network request

If a website populates content by fetching a JSON object, you can scrape just the network request and thus avoid having to deal with HTML altogether. To do this, you can use the fetch_resource browser action as show below.

🚧

fetch_resource cannot be combined with any other instructions and can only be used with separate requests.

For example, when loading yahoo.com and opening the Network tab, we can see an exp.json file being loaded:

If you wish to scrape just the contents of this request, you can use the fetch_resource browser action. Note that filter is a regular expression that matches the filename:

{
    "target": "universal",
    "url": "https://www.yahoo.com/",
    "browser_actions": [
        {
            "type": "fetch_resource",
            "filter": "/ybar/exp"
        }
    ]
}

Results

{
    "results": [
        {
            "content": "{\n    \"expCount\":5,\n    \"selection\":\"individual\",\n ... }",
            "status_code": 200,
            "url": "https://example.com/api/product/1",
            "task_id": "7131940420107377665",
            "created_at": "2023-11-19 09:46:41",
            "updated_at": "2023-11-19 09:47:08"
        }
    ]
}

Actions

click

NameArgumentsDescription
clickSelectors ["xpath", "css", "text"]
value: string
Clicks an element and wait a set count of seconds.

input

NameArgumentsDescription
inputSelectors ["xpath", "css", "text"]
value: string
Enters a text into a selected element.

scroll

NameArgumentsDescription
scrollx: integer
y: integer
Scrolls a set count of pixels.

scroll_to_bottom

NameArgumentsDescription
scroll_to_bottom-Scrolls to bottom for a set count of seconds.

wait

NameArgumentsDescription
waitwait_time_sWaits a set count of seconds.

Example:

{
    "target": "universal",
    "url": "https://news.ycombinator.com/",
    "headless": "html",
    "browser_actions": [
        {
            "type": "wait",
            "wait_time_s": "20"
        }
    ]
}

wait_for_element

NameArgumentsDescription
wait_for_elementSelectors ["xpath", "css", "text"]
value: string
Waits for element to load for a set count of seconds.

fetch_resource

NameArgumentsDescription
fetch_resource-Fetches the first occurrence of a Fetch/XHR resource matching the set pattern.

fetch_resource cannot be combined with any other instructions and should be used with separate requests.

General Arguments

Arguments available for all actions above

type

NameDescription
typeType of browser action used

timeout_s

NameDescription
timeout_sHow much time in seconds to wait at max until the execution of the action is terminated.

wait_time_s

NameDescription
wait_time_sHow much time in seconds to use explicitly to execute the action.

on_error

NameDescription
on_errorIndicator what to do with actions in case they fail:
"error": Stops the execution of browser actions.
"skip": Continues with the next action.