Appetize Docs
HomeDemoUploadPricing
  • Introduction
  • Platform
    • App Management
      • Uploading Apps
        • Android
        • iOS
      • App Dashboard
      • Running Apps
      • App Permissions
    • Device Sandbox
    • Embedding
    • Sharing
    • Session Inactivity Timeout
    • Query Params Reference
  • Features
    • Devices & OS Versions
    • Network Traffic Monitor
    • Debug Logs
    • UI Automation
    • Proxy
    • Language & Locale
    • Mock Location
    • Deep links
    • Launch Params
    • Media
    • Auto-grant Permissions
    • Custom Branding
    • Custom Launch Pages
    • Advanced Features
      • Android
        • ADB tunnel
        • Hide Password Visibility
      • Reserved Devices
  • Account
    • Invite your team
    • Single Sign-On
      • OpenID Connect
      • SAML
      • Azure Active Directory
      • Google Workspace (GSuite)
    • Reporting
      • Session History
      • Usage Summary
  • Infrastructure
    • Configure Network Access
    • Enterprise Hosting Options
  • JavaScript SDK
    • Configuration
    • Automation
      • Device commands
      • Touch interactions
    • API reference
      • Initialization
      • Client
      • Session
      • Types
        • AdbConnectionInfo
        • AppetizeApp
        • AndroidElementAttributes
        • Coordinates
        • DeviceInfo
        • Element
        • ElementBounds
        • IOSAccessibilityElement
        • IOSElementAttributes
        • NetworkRequest
        • NetworkResponse
        • SessionConfig
        • SwipeMove
        • RecordedAction
        • RecordedSwipeAction
        • RecordedKeypressAction
        • RecordedPosition
        • RecordedTapAction
        • RecordedTouchAction
        • UserInteraction
  • Testing
    • Getting Started
    • Writing Tests
    • Running Tests
    • Test Configuration
    • Continuous Integration
    • Record Tests (experimental)
    • Trace Viewer
    • Web Tests on Mobile Browsers
  • REST API
    • Create new app
    • Update existing app
    • Direct file uploads
    • Delete app
    • List apps
    • Usage summary
    • Devices & OS Versions
      • v1
    • IP Blocks
      • v1
    • Sample code
  • Guides & Samples
    • Impersonation
    • Automate Sign-in Flow
    • Screenshot Automation
    • Unlock Device
    • Validate Analytics Events
    • Lock Your Device to One App
    • Test Accessibility Font Sizes
    • Common testing scenarios
    • Samples Repository
  • Deprecated
    • Cross-document messages
  • Changelog
  • Additional Support
    • Knowledge Base
    • Support Request
Powered by GitBook
On this page
  1. Platform

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

PreviousSession Inactivity TimeoutNextFeatures

Last updated 1 month ago

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 , and observe changes to your browser's address bar.

Sample Structure
https://appetize.io/{app/embed}/{buildId|appId|publicKey}?{queryParameter1}={value1}&{queryParameter2}={value2}
e.g.
https://appetize.io/app/1234?device=pixel4&language=en
Query Parameter
Sample Values
Description

device

iphone8, iphone11pro, iphone11promax, ipadair2, pixel4, pixel4xl, galaxytabs7

codec

h264, jpeg

Changes the codec used for video streaming.

osVersion

11.4, 12.2, 13.3, 14.0

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.

scale

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).

autoplay

true, false

When true, starts streaming the app on page load. Default is false Note: If you are making use of our JavaScript SDK, we recommend starting the session programmatically using client.startSession() instead as this may cause the session to start before the SDK is ready.

orientation

portrait, landscape

Specifies the device orientation. Default is portrait

centered

vertical, horizontal, both

Centers the device (only when embedding).

deviceColor

black, white

Specifies the color of the device frame.

screenOnly

true, false

When true, only shows the screen, i.e., no device frame. Default is false

toast

top, bottom

Adjusts the position of Appetize toast messages used for displaying error or info messages. Default is bottom

xdocMsg

true, false

adbShellCommand

Android only

am start -a android.intent.action.VIEW -d https://appetize.io/ encoded as am%20start%20-a%20android.intent.action.VIEW%20-d%20https%3A%2F%2Fappetize.io%2F

Executes an adb shell command on the device.

language

af-ZA, fr-FR

locale

iOS Only

en_GB, fr_FR

Specifies the locale of the device via Locale ID.

iosKeyboard

iOS Only

lv_LV@sw=QWERTY encoded as lv_LV%40sw%3DQWERTY%20

iosAutocorrect

iOS Only

true, false

Turn on Auto-Correction for iOS.

Defaults to true

disableVirtualKeyboard

Android Only

true, false

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

location

iOS 12+ Android 10+

latitude, longitude, e.g. 39.903924,116.391432

Specifies the simulated location of the device.

timezone

Android Only

Australia/Adelaide encoded as Australia%2FAdelaide

grantPermissions

true, false

hidePasswords

Android Only

true, false

Hides password visibility when typing.

launchApp

boolean | string

Indicates whether an app launches after installation and allows specifying which installed app to open.

Possible values:

  • false - Apps install but do not launch.

  • true or undefined – Default behavior

launchUrl

https://www.appetize.io encoded as https%3A%2F%2Fwww.appetize.io

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

launchArgs

iOS Only

["apple", "banana", "pear"]

encoded as

%5B%22apple%22%2C%20%22banana%22%2C%20%22pear%22%5D

Specifies a URL-encoded JSON array of strings to pass when launching the app.

debug

true, false

When true, allows viewing the debug log for the app. Default is false

proxy

encoded as

http%3A%2F%2Fexample.com%3A8080%2F

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.

enableAdb

Android Only

true, false

record

true, false

audio

Android Only

true,false

Enables audio output on the Appetize device. Note: This feature is currently in Alpha and might not always work as expected.

androidPackageManager

Android Only

true, false

Allows installation of additional APKs after app launch. Default is false

resetGms

Android Only

true, false

Reset or reinitialize aspects of the Google Messaging Service. Default is false

region

us,eu

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.

appearance

iOS 13+ Android 10+

light, dark

Applies the theme's appearance to the device. Default is light

params

{"foo":"bar"} encoded as %7B%22foo%22%3A%22bar%22%7D

Specifies the device to simulate. See for more values.

Specifies the operating system version on which to run the app. See for more values.

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

Specifies the language of the device via language codes.

Specifies the iOS software keyboard to use.

Specifies the URL-encoded timezone of the device.

Automatically grant app permissions. See .

appId - Launches the app with the specified (e.g., com.android.chrome).

On session start, generates an SSH tunnel to allow ADB connections to the emulator. For more information see .

Enables recording of all user actions that took place during the session. See for more information.

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:

online demo
Launch Params
Devices & OS Versions
Devices & OS Versions
Javascript SDK
ISO 639-1 & BCP 47
Available Values
Available Values
Auto-grant Permissions
http://example.com:8080/
ADB tunnel
UI Automation
app Identifier