Query Params Reference
With query parameters on Appetize, users can easily switch between different device and operating system versions, languages, and many other options in order to customize their experience
Supported Query Parameters
Appetize's App and Embed links can contain several additional query parameters to help customize your experience with your app.
You may see these query parameters in action when you run our online demo, and observe changes to your browser's address bar.
device
Query Parameter | Sample Values | Description |
---|---|---|
iphone8, iphone11pro, iphone11promax, ipadair2, pixel4, pixel4xl, galaxytabs7 | Specifies the device to simulate. See Devices & OS Versions for more values. | |
h264, jpeg | Changes the codec used for video streaming. | |
11.4, 12.2, 13.3, 14.0 | Specifies the operating system version on which to run the app. See Devices & OS Versions for more values. Note: It is recommended not to include | |
a number between 10 and 100, or | Adjusts the size of the device shown on the page. | |
true, false | When true, starts streaming the app on page load. Default is | |
portrait, landscape | Specifies the device orientation.
Default is | |
vertical, horizontal, both | Centers the device (only when embedding). | |
black, white | Specifies the color of the device frame. | |
true, false | When true, only shows the screen, i.e., no device frame.
Default is | |
top, bottom | Adjusts the position of Appetize toast messages used for displaying error or info messages.
Default is | |
true, false | When true, enables cross-document messages. Note: It is recommended to rather use our Javascript SDK to interact with the device. | |
| Executes an | |
af_ZA, fr_FR | Specifies the language of the device via ISO 639-1 & BCP 47 language codes. | |
en_GB, fr_FR | Specifies the locale of the device via Locale ID. | |
| Specifies the iOS software keyboard to use. Available Values | |
true, false | Turn on Auto-Correction for iOS. Defaults to | |
true, false | When true, disables the on-screen keyboard.
Default is | |
latitude, longitude, e.g. 39.903924,116.391432 | Specifies the simulated location of the device. | |
| Specifies the URL-encoded timezone of the device. Available Values | |
true, false | Automatically grant app permissions. See Auto-grant Permissions. | |
true, false | Hides password visibility when typing. | |
| Specifies a deep link to open when the app is launched. | |
encoded as
| Specifies a URL-encoded JSON array of strings to pass when launching the app. | |
true, false | When true, allows viewing the debug log for the app.
Default is | |
encoded as
For Appetize's intercepting proxy, use | Specifies a proxy server to route network traffic. Note: Our current support is limited to HTTP Proxies. When your app makes HTTPS connections, the data remains encrypted despite the unencrypted connection to the proxy. The app sends a CONNECT request to the proxy for the destination HTTPS server, initiating an SSL handshake. The proxy acts as a TCP connection forwarder, ensuring end-to-end encryption for app data. | |
true, false | On session start, generates an SSH tunnel to allow ADB connections to the emulator. For more information see ADB tunnel. | |
true, false | Enables recording of all user actions that took place during the session. See UI Automation for more information. | |
true,false | Enables audio output on the Appetize device. Note: This feature is currently in Alpha and might not always work as expected. | |
true, false | Allows installation of additional APKs after app launch.
Default is | |
true, false | Reset or reinitialize aspects of the Google Messaging Service.
Default is | |
| Ensures that Appetize sessions are launched only from servers in a specific region. Note: It is best to avoid setting this property unless absolutely necessary. Our system automatically directs requests to the closest servers for optimal performance. Using this property could lead to longer queues in busy regions. | |
light, dark | Applies the theme's appearance to the device.
Default is | |
| A URL-encoded JSON object that will be passed to your app on launch. Use this to load custom content, skip onboarding, auto-login the specified user, or custom tracking. More info: Launch Params |
Last updated