Skip to main content
POST
/
v1
/
sessions
/
{sessionId}
/
scroll
Scroll
curl --request POST \
  --url https://api.anchorbrowser.io/v1/sessions/{sessionId}/scroll \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '
{
  "x": 123,
  "y": 123,
  "deltaY": 123,
  "deltaX": 123,
  "steps": 123,
  "useOs": true
}
'
{
  "status": "<string>"
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Path Parameters

​
sessionId
string<uuid>
required

The ID of the browser session

Body

application/json
​
x
integer
required

X coordinate

​
y
integer
required

Y coordinate

​
deltaY
integer
required

Vertical scroll amount (positive is down, negative is up)

​
deltaX
integer

Horizontal scroll amount (positive is right, negative is left)

​
steps
integer

Number of steps to break the scroll into for smoother scrolling

​
useOs
boolean

Whether to use the OS scroll or the Playwright scroll

Response

Scroll performed successfully

​
status
string