REST API
FreshThe REST API provides HTTP endpoints for controlling Android devices from any programming language or tool.
Download: TotalControl-REST-API-3.4.0-EN.zip (full manual)
Authentication
REST API uses token-based authentication.
Device Management
| Endpoint | Description |
|---|---|
connectAll | Auto-connect all detected devices |
getMain | Get primary device ID |
searchObject(name) | Find device by name |
searchObject(group) | Find device by group |
searchObject(tag) | Find device by tag |
App Control
| Endpoint | Description |
|---|---|
runApp | Launch application |
closeApp | Close application |
restartApp | Restart application |
installApp | Install APK |
uninstallAPK | Remove application |
getActivity | Get current activity |
getForegroundApp | Get active app |
getInstalledAPKList | List installed apps |
Input Operations
| Endpoint | Description |
|---|---|
click | Tap at coordinates |
swipe | Swipe gesture |
scroll | Scroll direction |
send | Send key event |
shift | Shift event |
move | Page movement |
Color Operations
| Endpoint | Description |
|---|---|
getPixelColor | Get color at coordinates |
compareColor | Compare colors |
compareColorEx | Extended comparison |
seekColor | Find color in area |
getColorBits | Color depth |
getColorCount | Count colors |
Image Operations
| Endpoint | Description |
|---|---|
screenshot | Capture screen |
screenshotToDevice | Save to device |
screenshotToMemory | Save to memory slot |
seekImage | Find image on screen |
seekImageByID | Find by image ID |
getData | Get image data |
clearMemslot | Clear memory slot |
Text Operations
| Endpoint | Description |
|---|---|
inputText | Enter text |
inputForm | Fill form fields |
getClipboardText | Read clipboard |
System Operations
| Endpoint | Description |
|---|---|
exec | Execute device command |
get | Get device property |
set | Set device property |
setName | Set device name |
lock / unlock | Lock/unlock screen |
getNotification | Read notification bar |
OCR
| Endpoint | Description |
|---|---|
analyzeText | OCR text recognition |
AAI / FindNode
| Endpoint | Description |
|---|---|
sendAai | Execute FindNode query |
getSetting | Get AAI settings |
clickSync | Synchronous click |
inputTextSync | Synchronous text input |
runAppSync | Synchronous app launch |
Script Management
| Endpoint | Description |
|---|---|
scriptRun | Execute script |
scriptKill | Stop script |
scriptList | List running scripts |
scriptWait | Wait for script completion |
File Operations
| Endpoint | Description |
|---|---|
| Upload | Upload file to device |
| Download | Download from device |
| Get info | File information |
Task Management
| Endpoint | Description |
|---|---|
taskCreate | Create parallel task |
taskDelete | Remove task |
taskInfo | Task details |
taskList | List tasks |
taskPause / taskResume | Pause/resume |
taskStop | Stop task |
taskSet | Configure task |
Calling JS API from REST
The REST API supports calling JS API functions via a POST endpoint, enabling the full power of the JavaScript API from external tools.