Scroll

scroll Function

The scroll function allows you to scroll the page vertically to a specific position. This can be useful for loading content that becomes visible as you scroll, or for moving to a specific part of the page to interact with elements that are not immediately in view.

Parameter	Required	Description
x	Required when scroll is being used	Integer | The x-axis position to scroll to
y	Required when scroll is being used	Integer | The y-axis position to scroll to
timeout	Optional	Integer | Controls the time to allow the scroll action run in ms
scroll_in_element	Optional	String | Enables scrolling inside a specific element (e.g., sidebar, modal, or div).

Example Request

cURL

curl -X POST 'https://api.webit.live/api/v1/realtime/web' \
--header 'Authorization: Basic <credential string>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://www.example.com",
    "render": true,
    "render_flow": [{
            "scroll": {
                "x": 0,
                "y": 100,
                "timeout": 20000
        }
    }]
}'

Like all Page Interactions, infinite scrolling is capped by the global 120-second session timeout, and will be terminated if this limit is reached.