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.
Sample Structure{app/embed}/{publicKey}?{queryParameter1}={value1}&{queryParameter2}={value2}
Query Parameter
Sample Values


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 osVersion as a query parameter when embedding the app, as this will always use our latest default version.


a number between 10 and 100, or auto
Adjusts the size of the device shown on the page. auto will scale to fit the size of the iframe (embeds only).


true, false
When true, starts streaming the app on page load. Default is false


portrait, landscape
Specifies the device orientation. Default is portrait


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 false


top, bottom
Adjusts the position of Appetize toast messages. Default is bottom


true, false
When true, enables cross-document messages. Note: It is recommended to rather use our Javascript SDK to interact with the device.


af_ZA, fr_FR
Specifies the language of the device via ISO 639-1 & BCP 47 language codes.


iOS Only
en_GB, fr_FR
Specifies the locale of the device via Locale ID.


iOS Only
[email protected]=QWERTY encoded as lv_LV%40sw%3DQWERTY%20
Specifies the iOS software keyboard to use. Available Values


Android Only
true, false
When true, disables the on-screen keyboard. Default is false


iOS 12+ Android 10+
latitude, longitude, e.g. 39.903924,116.391432
Specifies the simulated location of the device.


Android Only
Australia/Adelaide encoded as Australia%2FAdelaide
Specifies the URL-encoded timezone of the device. Available Values


Android Only
true, false
Automatically grants all required app permissions. Default is false


Android Only
true, false
Hides password visibility when typing.

launchUrl encoded as
Specifies a deep link to open when the app is launched.


iOS Only
["apple", "banana", "pear"]
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 false


encoded as
For Appetize's intercepting proxy, use intercept.
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.


Android Only
true, false
On session start, generates an SSH tunnel to allow ADB connections to the emulator.


true, false
Enables recording of all user actions that took place during the session. See UI Automation for more information.


Enables audio output on the Appetize device.


Android Only
true, false
Allows installation of additional APKs after app launch. Default is false


iOS 13+ Android 10+
light, dark
Applies the theme's appearance to the device. Default is light


{"foo":"bar"} encoded as %7B%22foo%22%3A%22bar%22%7D
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