Skip to content
Lightcone Lightcone
NorthstarPlatformPricingLogin
API Reference
Computers

Press and hold mouse button

computers.mouse_down(strid, ComputerMouseDownParams**kwargs) -> ActionResult
POST/computers/{id}/mouse-down

Press and hold the left mouse button at the specified x,y coordinates. The button stays held until a corresponding mouse-up call. Coordinates are screenshot pixel positions.

Use cases: Long press, map panning, combining with /key-down for Shift+Click, or fine-grained control over drag sequences.

For drag-and-drop, prefer the /drag endpoint which handles the full press-move-release sequence automatically.

Important: Always pair with a mouse-up call to release the button.

ParametersExpand Collapse
id: str
tab_id: Optional[str]
x: Optional[float]
y: Optional[float]
ReturnsExpand Collapse
class ActionResult: …
error_message: Optional[str]
executed_tab_id: Optional[str]
page_context: Optional[PageContext]
device_scale_factor: Optional[float]
is_main_tab: Optional[bool]
page_height: Optional[int]
page_width: Optional[int]
scroll_x: Optional[float]
scroll_y: Optional[float]
tab_id: Optional[str]
title: Optional[str]
url: Optional[str]
viewport_height: Optional[int]
viewport_width: Optional[int]
request_id: Optional[str]
result: Optional[Dict[str, object]]
status: Optional[str]
timestamp: Optional[str]

Press and hold mouse button

import os
from tzafon import Lightcone

client = Lightcone(
    api_key=os.environ.get("TZAFON_API_KEY"),  # This is the default and can be omitted
)
action_result = client.computers.mouse_down(
    id="id",
)
print(action_result.executed_tab_id)
{
  "error_message": "error_message",
  "executed_tab_id": "executed_tab_id",
  "page_context": {
    "device_scale_factor": 0,
    "is_main_tab": true,
    "page_height": 0,
    "page_width": 0,
    "scroll_x": 0,
    "scroll_y": 0,
    "tab_id": "tab_id",
    "title": "title",
    "url": "url",
    "viewport_height": 0,
    "viewport_width": 0
  },
  "request_id": "request_id",
  "result": {
    "foo": "bar"
  },
  "status": "status",
  "timestamp": "timestamp"
}
Returns Examples
{
  "error_message": "error_message",
  "executed_tab_id": "executed_tab_id",
  "page_context": {
    "device_scale_factor": 0,
    "is_main_tab": true,
    "page_height": 0,
    "page_width": 0,
    "scroll_x": 0,
    "scroll_y": 0,
    "tab_id": "tab_id",
    "title": "title",
    "url": "url",
    "viewport_height": 0,
    "viewport_width": 0
  },
  "request_id": "request_id",
  "result": {
    "foo": "bar"
  },
  "status": "status",
  "timestamp": "timestamp"
}