Pro Intents API Overview
GPS JoyStick exposes an Intent-based API that allows external apps and scripts to control location mocking programmatically. Intents are sent as Android Service intents targeting the GPS JoyStick package.
Package: com.theappninjas.fakegpsjoystick
Target: Service (all intents)
Type note: All input extras for numeric values (coordinates, speed, offset) use
float. The STATUS_RESPONSE output extras usedoublefor these same values. Each intent's page documents the exact types. When in doubt, check the specific intent reference.
Available Intent Actions
Section titled “Available Intent Actions”Free Intents
Section titled “Free Intents”These work with any version of GPS JoyStick:
| Action | Description | Docs |
|---|---|---|
theappninjas.gpsjoystick.TELEPORT | Teleport to coordinates | Teleport |
theappninjas.gpsjoystick.ROUTE | Start a saved route | Route |
theappninjas.gpsjoystick.STOP | Stop all mocking | Stop/Pause/Resume |
Pro Intents
Section titled “Pro Intents”These require an active Pro subscription:
| Action | Description | Docs |
|---|---|---|
theappninjas.gpsjoystick.WALK | Walk through waypoints | Route |
theappninjas.gpsjoystick.ROUTE_PAUSE | Pause the active route | Stop/Pause/Resume |
theappninjas.gpsjoystick.ROUTE_RESUME | Resume a paused route | Stop/Pause/Resume |
theappninjas.gpsjoystick.ROUTE_NEXT | Advance to next waypoint | Stop/Pause/Resume |
theappninjas.gpsjoystick.ROUTE_PREV | Go to previous waypoint | Stop/Pause/Resume |
theappninjas.gpsjoystick.HIDE | Hide the on-screen joystick | Speed & Joystick |
theappninjas.gpsjoystick.SHOW | Show the on-screen joystick | Speed & Joystick |
theappninjas.gpsjoystick.SPEED | Set movement speed | Speed & Joystick |
theappninjas.gpsjoystick.FAVORITES | Teleport to a saved favorite | Teleport |
theappninjas.gpsjoystick.RECORD_START | Start recording a route | Route |
theappninjas.gpsjoystick.RECORD_ADD | Add waypoint to recording | Route |
theappninjas.gpsjoystick.RECORD_STOP | Stop and save/discard recording | Route |
theappninjas.gpsjoystick.GENERATE | Generate a random route | Route |
theappninjas.gpsjoystick.STATUS | Query runtime state | Status Query |
Error Handling
Section titled “Error Handling”All intents broadcast theappninjas.gpsjoystick.ERROR on failure with these extras:
| Extra | Type | Description |
|---|---|---|
source_action | String | The intent action that failed |
error | String | Error code |
message | String | Human-readable description |
Error codes: PRO_REQUIRED, INVALID_EXTRAS, FAVORITE_NOT_FOUND, NOT_RECORDING, SAVE_FAILED, NOT_WALKING, NO_ROUTE_ACTIVE, ALREADY_RECORDING
If the service is not running when an intent is received, the app will automatically launch and attempt to process the command. Invalid or empty waypoints are silently ignored rather than producing an error broadcast.
Deep Links
Section titled “Deep Links”GPS JoyStick also supports the gpsjoystick:// URL protocol as an alternative to intents. Deep links can be triggered from browsers, other apps, QR codes, or NFC tags - no intent-capable launcher required. Most actions available as intents have equivalent deep links, with the exception of STATUS (intent-only).
See the Deep Links reference for the full URL syntax.
Integration Guides
Section titled “Integration Guides”- Tasker Integration - Step-by-step setup with downloadable profiles
- MacroDroid Integration - Tasker alternative with visual automation
- ADB Commands Cheatsheet - Quick reference for shell control
- Deep Links -
gpsjoystick://URL protocol reference