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,
  "deltaX": 0,
  "deltaY": 100,
  "steps": 10,
  "useOs": false
}'
{
  "status": "success"
}

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)

Example:

100

​
deltaX
integer
default:0

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

Example:

0

​
steps
integer
default:1

Number of steps to break the scroll into for smoother scrolling

Example:

10

​
useOs
boolean
default:true

Whether to use the OS scroll or the Playwright scroll

Example:

false

Response

Scroll performed successfully

​
status
string
Example:

"success"